Referencia (endpoints)Formularios

Ver las respuestas de un formulario

Sirve para leer las respuestas de un formulario, de todas sus versiones, con filtros por fecha, versión o contacto; por ejemplo para exportarlas o revisarlas.

GET
/forms/families/{familyId}/responses

Permiso requerido: Contactos y conversaciones → Ver

Lista las respuestas de un formulario de tu cuenta, de la más reciente a la más antigua, sumando todas sus versiones. Junto a data viene columns, las preguntas que usan esas respuestas. {familyId} es el family_id del formulario. Filtra con from y to (fechas), version_id (el id de una versión de ese formulario), origin, status y search (nombre o teléfono del contacto). Un filtro con un valor inválido responde 422. Pagina con perPage (1 a 100, 25 por defecto). Responde 404 si el formulario no existe o no es de tu cuenta.

Autorización

http
headerAuthorizationBearer <clave>

Parámetros de la ruta

familyId*string

Id opaco: un texto que empieza con frm_. Se usa tal como llega; no se arma ni se interpreta.

Patrón^frm_[A-Za-z0-9]{23}$

Parámetros de consulta

from?|
Formatodate-time
to?|
Formatodate-time
version_id?|

Id opaco: un texto que empieza con frv_. Se usa tal como llega; no se arma ni se interpreta.

Patrón^frv_[A-Za-z0-9]{23}$
origin?|
Largolength <= 24
status?|
Largolength <= 24
kind?|
Largolength <= 24
effect_status?|
Largolength <= 24
search?|
Largolength <= 191
page?|
Rango1 <= value
perPage?integer
Rango1 <= value <= 100
Por defecto25

Cuerpo de la respuesta

OK

application/json
  1. response
data*array<>
links*
meta*
curl -X GET "https://example.com/forms/families/frm_AyJUGabeXUAk9dbBuWegw4B/responses"
{  "data": [    {}  ],  "links": {    "first": "string",    "last": "string",    "prev": "string",    "next": "string"  },  "meta": {    "current_page": 0,    "from": 0,    "last_page": 0,    "links": [      {        "url": "string",        "label": "string",        "active": true      }    ],    "path": "string",    "per_page": 0,    "to": 0,    "total": 0  }}

Esto es lo que se copia para tu IA

Cargando…