GET /v1/admin/customers
List all customers
Returns all customers with subscription and usage statistics (Platform Admin only)
Request
GET /v1/admin/customers
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",
"inactive",
"trial"
]
},
"required": false,
"name": "status",
"in": "query"
},
{
"schema": {
"type": "string"
},
"required": false,
"name": "package_id",
"in": "query"
}
]
Response
{
"200": {
"description": "Customers retrieved successfully",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"data": {
"type": "object",
"properties": {
"customers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"full_name": {
"type": "string"
},
"email": {
"type": "string"
},
"phone": {
"type": "string"
},
"created_at": {
"type": "string"
},
"subscription": {
"type": [
"object",
"null"
],
"properties": {
"package_name": {
"type": "string"
},
"status": {
"type": "string"
},
"billing_cycle": {
"type": "string"
},
"current_period_end": {
"type": "string"
}
},
"required": [
"package_name",
"status",
"billing_cycle",
"current_period_end"
]
},
"usage": {
"type": "object",
"properties": {
"companies_count": {
"type": "number"
},
"properties_count": {
"type": "number"
},
"rooms_count": {
"type": "number"
},
"reservations_count": {
"type": "number"
},
"total_revenue": {
"type": "number"
}
},
"required": [
"companies_count",
"properties_count",
"rooms_count",
"reservations_count",
"total_revenue"
]
}
},
"required": [
"id",
"full_name",
"email",
"phone",
"created_at",
"subscription",
"usage"
]
}
},
"pagination": {
"type": "object",
"properties": {
"page": {
"type": "number"
},
"limit": {
"type": "number"
},
"total": {
"type": "number"
},
"total_pages": {
"type": "number"
}
},
"required": [
"page",
"limit",
"total",
"total_pages"
]
},
"summary": {
"type": "object",
"properties": {
"total_customers": {
"type": "number"
},
"active_subscriptions": {
"type": "number"
},
"trial_users": {
"type": "number"
},
"total_mrr": {
"type": "number"
}
},
"required": [
"total_customers",
"active_subscriptions",
"trial_users",
"total_mrr"
]
}
},
"required": [
"customers",
"pagination",
"summary"
]
}
},
"required": [
"success",
"data"
]
}
}
}
},
"403": {
"description": "Platform admin access required"
}
}
View in Interactive API Reference