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}/audience

Parámetros de la URL

Parámetro	Tipo	Descripción	Requerimiento
`campaignId`	string	Identificador único de la campaña	obligatorio

Parámetros de consulta (Query)

Parámetro	Tipo	Descripción	Valor por defecto
`limit`	number	Cantidad de registros a retornar (máximo 500)	`50`
`offset`	number	Cantidad de registros a omitir (para paginación)	`0`
`sortBy`	string	Campo por el cual ordenar los resultados	`lastUpdate`
`sortDirection`	string	Dirección del ordenamiento: `"asc"` o `"desc"`	`desc`

Respuesta `200 OK`

{
  "status": "success",
  "message": "Audience fetched successfully",
  "data": [
    {
      "id": "zUBQxKLYQm3LcUKqLbJU",
      "phoneNumber": "521234567890",
      "name": "Juan Pérez",
      "firstname": null,
      "lastname": null,
      "email": null,
      "birthdate": null,
      "gender": null,
      "company": null,
      "country": null,
      "state": null,
      "city": null,
      "address": null,
      "postalCode": null,
      "tags": ["campaign-cdk9dYQt3Cr1BGRqX6SD"],
      "owners": [],
      "customFields": {},
      "creationDate": "2026-03-02T18:32:28.903Z",
      "lastUpdate": "2026-03-05T16:54:25.221Z",
      "whatsappStatus": "active"
    }
  ],
  "pagination": {
    "limit": 50,
    "offset": 0,
    "count": 1
  }
}

Campos de la respuesta

Objeto `data[]`

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
`whatsappStatus`	string \| undefined	Estado de entrega o mensajería del contacto cuando existe

Objeto `pagination`

Campo	Tipo	Descripción
`limit`	number	Registros solicitados por página
`offset`	number	Desplazamiento utilizado
`count`	number	Registros retornados en esta página

Errores comunes

Código	Descripción
`401`	API Key inválida o expirada
`404`	La campaña no existe o fue eliminada lógicamente
`500`	Error interno al consultar la audiencia

Notas

Para obtener la siguiente página incrementa offset en el valor de limit.
limit se restringe a un máximo de 500.

Anterior Enviar Campaña Siguiente Agregar Audiencia

Obtener Audiencia de Campaña

Parámetros de la URL

Parámetros de consulta (Query)

Respuesta 200 OK

Campos de la respuesta

Objeto data[]

Objeto pagination

Errores comunes

Notas

Respuesta `200 OK`

Objeto `data[]`

Objeto `pagination`