GET /v1/companies/{id}
Get company details
Returns detailed information about a specific company including members, properties, and statistics
Request
GET /v1/companies/{id}
Parameters
[
{
"schema": {
"type": "string"
},
"required": true,
"name": "id",
"in": "path"
}
]
Response
{
"200": {
"description": "Company details retrieved successfully",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"data": {
"type": "object",
"properties": {
"company": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"user_id": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"tax_number": {
"type": [
"string",
"null"
]
},
"tax_office": {
"type": [
"string",
"null"
]
},
"address": {
"type": [
"string",
"null"
]
},
"city": {
"type": [
"string",
"null"
]
},
"phone": {
"type": [
"string",
"null"
]
},
"email": {
"type": [
"string",
"null"
]
},
"status": {
"type": "string"
},
"metadata": {},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"members": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"user_id": {
"type": "string"
},
"full_name": {
"type": "string"
},
"email": {
"type": "string"
},
"role": {
"type": "string"
},
"status": {
"type": "string"
},
"joined_at": {
"type": "string"
}
},
"required": [
"id",
"user_id",
"full_name",
"email",
"role",
"status",
"joined_at"
]
}
},
"stats": {
"type": "object",
"properties": {
"total_members": {
"type": "number"
},
"total_properties": {
"type": "number"
},
"total_rooms": {
"type": "number"
},
"active_reservations": {
"type": "number"
},
"monthly_revenue": {
"type": "number"
},
"occupancy_rate": {
"type": "number"
}
},
"required": [
"total_members",
"total_properties",
"total_rooms",
"active_reservations",
"monthly_revenue",
"occupancy_rate"
]
}
},
"required": [
"id",
"user_id",
"name",
"type",
"tax_number",
"tax_office",
"address",
"city",
"phone",
"email",
"status",
"created_at",
"updated_at",
"members",
"stats"
]
}
},
"required": [
"company"
]
}
},
"required": [
"success",
"data"
]
}
}
}
},
"403": {
"description": "Access denied to this company"
},
"404": {
"description": "Company not found"
}
}
View in Interactive API Reference