Saltar al contenido principal

Obtener una lista

GET/v1/lists/{id}

Para desarrolladores

Descripción​

Devuelve una lista por su identificador.

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​

Path params:

idintegerobligatorio
Identificador de la lista.

Response​

200 OKDevuelve un objeto con 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.

Errores​

CódigoCuándo
404La lista no existe o fue eliminada (list_not_found).
Request
curl -X GET "https://$API_HOST/v1/lists/4" \
-H "Authorization: Bearer $API_KEY" \
-H "X-Instance-Slug: $SLUG"
Response
{
"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"
}