Saltar al contenido principal

Listar listas

GET/v1/lists

Para desarrolladores

Descripción​

Una lista es un conjunto de contactos que se carga desde un archivo CSV. Cada columna del archivo se declara como un campo del catálogo (PUT /v1/lists/{id}/fields), y los datos de la lista quedan tal como se cargaron hasta la próxima importación. Si lo que se necesita es un registro que se actualiza con el tiempo desde varias fuentes, el recurso es un dataset (ver Campos, formularios y consentimiento).

Este endpoint lista las listas de la cuenta, de la más reciente a la más antigua.

Autenticación​

Authorizationbearer tokenheaderobligatorio
API key con scope list:read. Formato: Bearer <API_KEY>.
X-Instance-Slugstringheaderobligatorio
Identificador de su instancia. Ver Autenticación.

Request​

Query params:

pageinteger
Número de página; la primera es la 1. Default: 1.
page_sizeinteger
Tamaño de página, 1–100. Default: 20.

Response​

200 OKDevuelve una página de resultados: data con los elementos y pagination para pedir la siguiente. Cada elemento tiene los campos que siguen.
idintegersiempre presente
Identificador de la lista.
namestringsiempre presente
Nombre visible, único entre las listas vigentes.
channelstring[] | null
Vías por las que se le puede hablar a sus contactos: mail, sms, wsp.
descriptionstring | null
Descripción libre.
row_countintegersiempre presente
Filas de la lista según la última importación completada. 0 mientras no se haya importado nada.
created_atstring (date-time)siempre presente
Fecha de creación (ISO 8601, UTC).
updated_atstring (date-time)siempre presente
Fecha de la última modificación de la lista.
Notas
Request
curl -X GET "https://$API_HOST/v1/lists" \
-H "Authorization: Bearer $API_KEY" \
-H "X-Instance-Slug: $SLUG"
Response
{
"data": [
  {
    "id": 4,
    "name": "Clientes marzo",
    "channel": [
      "mail"
    ],
    "description": null,
    "row_count": 0,
    "created_at": "2026-10-14T12:00:00Z",
    "updated_at": "2026-10-14T12:00:00Z"
  }
],
"pagination": {
  "page": 1,
  "page_size": 20,
  "has_more": false,
  "total_items": 1,
  "total_pages": 1
}
}