Listar Clientes
Obtiene la lista de clientes de todos tus workspaces con opciones de paginación y filtrado.
GET https://api.platica.mx/v1/clientsParámetros de consulta
| Parámetro | Tipo | Descripción | Requerido |
|---|---|---|---|
limit | number | Límite de clientes en la respuesta. Máximo: 100. Por defecto: 50 | — |
offset | number | Número de registros a saltar (para paginación) | — |
sortBy | enum | Campo para ordenar: name (default) o creationDate | — |
sortDirection | enum | Dirección del ordenamiento: asc (default) o desc | — |
tags | array | Lista de etiquetas para filtrar | — |
dateFilter | object | Filtro por fecha o período | — |
Fecha específica:
GET /v1/clients?dateFilter={"type":"specific","date":"2024-01-15"}Rango de fechas:
GET /v1/clients?dateFilter={"type":"range","startDate":"2024-01-01","endDate":"2024-01-31"}Respuesta
{
"workspaces": [
{
"id": "g6yCA16pkWl5eXo7KszB",
"name": "ws_1",
"clients": [
{
"id": "167b545fcde641dcb319eca0cc4d7b0f",
"phoneNumber": "12345678910",
"name": "José",
"tags": [],
"creationDate": "2025-02-06T16:45:50.146Z",
"lastUpdate": "2025-02-06T16:45:50.146Z",
"firstname": "José",
"lastname": "García",
"gender": "male",
"customFields": {
"placas": "",
"id_recepcion": "",
"fecha_siniestro": ""
},
"owners": ["user1@company.com", "user2@company.com"]
}
],
"clientsCount": 1,
"pagination": {
"limit": 50,
"offset": 0,
"hasMore": true
}
}
]
}