Listar Campañas
Obtiene la lista de campañas activas del workspace autenticado con opciones de paginación.
GET https://api.platica.mx/v1/campaignsParámetros de consulta
| Parámetro | Tipo | Descripción | Requerido |
|---|---|---|---|
limit | number | Límite de campañas 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",
"campaignsCount": 2,
"campaigns": [
{
"id": "EgIOvaKPmrQFfuh6D023",
"title": "solicitud_rfc_facturacion",
"category": "utility",
"platform": "whatsapp",
"templateName": "solicitud_rfc_facturacion",
"owners": [
"soporte@empresa.com"
],
"language": "es_MX",
"creationDate": "2026-02-11T18:55:52.061Z",
"lastUpdate": "2026-02-11T19:46:29.285Z"
},
{
"id": "FhJPrbLQnsRGgvi7E134",
"title": "Promo Verano",
"category": "marketing",
"platform": "whatsapp",
"templateName": "promo_verano_2026",
"owners": [],
"creationDate": "2026-02-14T10:00:00.000Z",
"lastUpdate": "2026-02-14T12:00:00.000Z"
}
],
"pagination": {
"limit": 50,
"offset": 0,
"hasMore": false
}
}
]
}Campos de la respuesta
| Campo | Descripción |
|---|---|
workspaces | Lista de workspaces con sus campañas |
Cada elemento de workspaces[]
| Campo | Descripción |
|---|---|
id | ID del workspace |
name | Nombre del workspace |
campaigns | Lista de objetos campaña |
Cada elemento de campaigns[]
| Campo | Descripción |
|---|---|
id | ID interno de la campaña |
title | Título de la campaña |
category | Categoría: marketing o utility |
platform | Plataforma de envío |
templateName | Nombre del template asociado cuando existe |
owners | Lista de correos de usuarios responsables |
language | Idioma del template cuando aplica (puede omitirse) |
creationDate | Fecha de creación en formato ISO 8601 |
lastUpdate | Fecha de última actualización en formato ISO 8601 |
Campos de paginación
| Campo | Descripción |
|---|---|
campaignsCount | Total de campañas devueltas 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 |