Ingresar
DocumentaciónGuíasReferenciaWebhooksRecursos
Participantes

Listar los participantes con su grupo actual

Usalo para saber en qué grupo está cada participante de una campaña, cuándo entró o salió y si sigue activo. Ideal para sincronizar miembros con tu CRM.

GET
/v1/campaigns/{campaign}/campaign-participants

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 joined_at, left_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 la ruta

campaign*integer

The campaign ID

Parámetros de consulta

search?string|null
status?|
Valor en"active""exited"null
orderBy?|
Valor en"joined_at""left_at"null
orderByMethod?|
Valor en"asc""desc""ASC""DESC"null
perPage?|
Rango1 <= value
start_date?|
Formatodate-time
end_date?|
Formatodate-time
timezone?string|null
date_rule?|
Valor en"1""2""3"null
selection_type?|
Valor en"all""none"null
groups_uids[]?array<string>

Cuerpo de la respuesta

Paginated set of CampaignParticipantResource

application/json
  1. response
data*array<>
links*
meta*
curl -X GET "https://example.com/v1/campaigns/0/campaign-participants"
{  "data": [    {      "id": "string",      "phone": "string",      "name": "string",      "lid": "string",      "group_id": "string",      "group_name": "string",      "joined_at": "string",      "left_at": "string",      "status": "string",      "source": "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  }}

Listar los participantes de una campaña GET

Sirve para listar los participantes de una campaña, con búsqueda por teléfono y si son administradores.

Listar entradas y salidas de una campaña GET

Sirve para obtener el registro de entradas y salidas de toda una campaña, con fecha, grupo y país, filtrando por tipo de evento, fechas o grupos.