Listar campañas

Usalo para listar las campañas de grupos de WhatsApp de tu cuenta, con búsqueda por nombre, y obtener sus IDs para consultar grupos, participantes o estadísticas.

GET
/v1/campaigns

Permiso requerido: communities:read (Leer)

Con API key: la respuesta siempre viene paginada. Tamaño de página: perPage (por defecto 25, máximo 100; un valor mayor, menor que 1 o no entero responde 422). Orden: orderBy acepta created_at, id, name, updated_at; dirección orderByMethod: asc o desc. Otro valor responde 422.

Autorización

http
headerAuthorizationBearer <clave>

Tu API key de Funnelchat, enviada en cada llamada como Authorization: Bearer <id>|fc_live_....

Parámetros de consulta

name?string
orderBy?string
orderByMethod?string
perPage?integer

Cuerpo de la respuesta

Paginated set of CampaignsResource

application/json
  1. response
data*array<>
links*
meta*
curl -X GET "https://example.com/v1/campaigns"
{  "data": [    {      "id": "string",      "uuid": "string",      "name": "string",      "custom_domain": "string",      "photo": "string",      "deviceId": "string",      "userId": "string",      "type": "string",      "is_active": "string",      "groups": "string",      "total_clicks": "string",      "total_in": "string",      "total_in_counter": 0,      "admins": "string",      "group_admins": "string",      "disconnected_groups": "string",      "connection_error_groups": "string",      "running_actions_count": "string",      "pending_actions_count": "string",      "pending_sync_groups": "string",      "group_creation_suspended": true,      "suspended_creator_phones": [],      "group_creation_has_available_creator": true,      "api_open_groups": 0,      "api_policy": {        "officialNumber": "string",        "officialLid": "string",        "companionNumbers": "string"      }    }  ],  "links": {    "first": "string",    "last": "string",    "prev": "string",    "next": "string"  },  "meta": {    "current_page": 1,    "from": 1,    "last_page": 1,    "links": [      {        "url": "string",        "label": "string",        "active": true      }    ],    "path": "string",    "per_page": 0,    "to": 1,    "total": 0  }}