GET /v1/companies
List user companies
Returns all companies owned by the authenticated user with member counts and basic stats
Request
GET /v1/companies
Parameters
[
{
"schema": {
"type": "string",
"default": "1"
},
"required": false,
"name": "page",
"in": "query"
},
{
"schema": {
"type": "string",
"default": "20"
},
"required": false,
"name": "limit",
"in": "query"
},
{
"schema": {
"type": "string",
"enum": [
"active",
"suspended"
]
},
"required": false,
"name": "status",
"in": "query"
}
]
Response
{
"200": {
"description": "Companies retrieved successfully",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"data": {
"type": "object",
"properties": {
"companies": {
"type": "array",
"items": {
"type": "object",
"properties": {
"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"
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"stats": {
"type": "object",
"properties": {
"total_members": {
"type": "number"
},
"total_properties": {
"type": "number"
},
"total_rooms": {
"type": "number"
},
"active_reservations": {
"type": "number"
}
},
"required": [
"total_members",
"total_properties",
"total_rooms",
"active_reservations"
]
}
},
"required": [
"id",
"name",
"type",
"tax_number",
"tax_office",
"address",
"city",
"phone",
"email",
"status",
"created_at",
"updated_at",
"stats"
]
}
},
"pagination": {
"type": "object",
"properties": {
"page": {
"type": "number"
},
"limit": {
"type": "number"
},
"total": {
"type": "number"
},
"total_pages": {
"type": "number"
},
"has_next": {
"type": "boolean"
},
"has_prev": {
"type": "boolean"
}
},
"required": [
"page",
"limit",
"total",
"total_pages",
"has_next",
"has_prev"
]
}
},
"required": [
"companies",
"pagination"
]
}
},
"required": [
"success",
"data"
]
}
}
}
}
}
View in Interactive API Reference