Obtener Audiencia de Campaña
Obtiene la lista paginada de clientes que forman parte de la audiencia de una campaña.
GET https://api.platica.mx/v1/campaigns/{campaignId}/audienceParámetros de la URL
| Parámetro | Tipo | Descripción | Requerimiento |
|---|---|---|---|
campaignId | string | Identificador único de la campaña | obligatorio |
Parámetros de consulta
| Parámetro | Tipo | Descripción | Requerido |
|---|---|---|---|
limit | number | Límite de clientes en la respuesta por workspace. Máximo: 500. Por defecto: 50 | — |
offset | number | Número de registros a saltar (para paginación) | — |
sortBy | enum | Campo para ordenar: lastUpdate (default) o creationDate | — |
sortDirection | enum | Dirección del ordenamiento: desc (default) o asc | — |
Respuesta
{
"workspaces": [
{
"id": "ws_abc123",
"name": "Empresa Principal",
"clientsCount": 2,
"clients": [
{
"id": "client_abc001",
"phoneNumber": "521234567890",
"name": "Ana García",
"firstname": "Ana",
"lastname": "García",
"email": "ana.garcia@example.com",
"birthdate": null,
"gender": "female",
"company": "Acme S.A.",
"country": "MX",
"state": "Jalisco",
"city": "Guadalajara",
"address": null,
"postalCode": null,
"tags": [
"campaign-abc123",
"Lead Calificado"
],
"owners": [
"agente@empresa.com"
],
"customFields": {},
"creationDate": "2026-03-02T18:32:28.903Z",
"lastUpdate": "2026-03-05T16:54:25.221Z"
},
{
"id": "client_abc002",
"phoneNumber": "529876543210",
"name": "Carlos Mendoza",
"firstname": "Carlos",
"lastname": "Mendoza",
"email": null,
"birthdate": null,
"gender": null,
"company": null,
"country": null,
"state": null,
"city": null,
"address": null,
"postalCode": null,
"tags": [
"campaign-abc123"
],
"owners": [],
"customFields": {},
"creationDate": "2026-03-03T10:15:00.000Z",
"lastUpdate": "2026-03-03T10:15:00.000Z"
}
],
"pagination": {
"limit": 50,
"offset": 0,
"hasMore": false
}
}
]
}Campos de la respuesta
| Campo | Tipo | Descripción |
|---|---|---|
workspaces | array | Lista de workspaces con la audiencia paginada |
Cada elemento de workspaces[]
| Campo | Tipo | Descripción |
|---|---|---|
id | string | ID del workspace |
name | string | Nombre del workspace |
clients | array | Lista de clientes de la audiencia |
Cada elemento de clients[]
| Campo | Tipo | Descripción |
|---|---|---|
id | string | ID interno del cliente |
phoneNumber | string | Número de teléfono en formato internacional |
name | string | null | Nombre completo del cliente |
firstname | string | null | Nombre del cliente |
lastname | string | null | Apellido del cliente |
email | string | null | Correo electrónico |
birthdate | string | null | Fecha de nacimiento en ISO 8601 |
gender | string | null | Género |
company | string | null | Empresa |
country | string | null | País |
state | string | null | Estado |
city | string | null | Ciudad |
address | string | null | Dirección |
postalCode | string | null | Código postal |
tags | string[] | Etiquetas del cliente (incluye la etiqueta de la campaña) |
owners | string[] | Correos de los usuarios responsables del cliente |
customFields | object | Campos personalizados del cliente |
creationDate | string | null | Fecha de creación en ISO 8601 |
lastUpdate | string | null | Fecha de última actualización en ISO 8601 |
Campos de paginación
| Campo | Descripción |
|---|---|
clientsCount | Total de clientes devueltos en ese workspace |
pagination.limit | Número máximo de resultados solicitados |
pagination.offset | Número de resultados omitidos |
pagination.hasMore | Indica si existen más resultados |