Saltar al contenido principal

Listar datasets

GET/v1/datasets

Para desarrolladores

Descripción​

Lista los datasets de la cuenta. Un dataset acumula contactos: se configura una sola vez y después recibe los contactos de los formularios vinculados a él y de POST /v1/datasets/{id}/contacts.

Al configurarlo se define qué columnas del catálogo de campos guarda, por qué identificador reconoce a un contacto y qué hace cuando ese contacto ya existe.

Los datasets se crean y se configuran en el panel, no desde la API. La API pública los lee y les agrega contactos.

Autenticación​

Authorizationbearer tokenheaderobligatorio
API key con scope dataset: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 del dataset. Es el {id} de POST /v1/datasets/{id}/contacts y de GET /v1/datasets/{id}/records.
namestringsiempre presente
Nombre visible.
is_activebooleansiempre presente
Un dataset inactivo deja de ofrecerse al conectar un formulario, pero sigue recibiendo contactos por la API y por los formularios ya conectados.
channelarray\<string\> | null
Canales de contacto habilitados: mail (correo), sms y wsp (WhatsApp). Si hay uno solo, determina el identificador: mail identifica por correo; sms y wsp, por teléfono.
descriptionstring | null
Descripción libre.
created_atstringsiempre presente
Fecha de creación (ISO 8601, UTC).
updated_atstringsiempre presente
Fecha de última modificación del dataset (no de sus contactos).
Notas
  • Esta respuesta no incluye el identificador ni las columnas del dataset. Se ven en el panel. El identificador está en Configuración, y en la lista de columnas el campo que identifica aparece marcado como Identidad. Si un contacto trae una columna que el dataset no declara, le falta una columna obligatoria o le falta el identificador, POST /v1/datasets/{id}/contacts lo rechaza con 409.
  • Las columnas que un dataset guarda se nombran con la field_key del catálogo de campos (GET /v1/fields).
Request
curl -X GET "https://cl1api.fidelizador.com/v1/datasets?page=1&page_size=20" \
-H "Authorization: Bearer <API_KEY>" \
-H "X-Instance-Slug: <slug>"
Response
{
"data": [
  {
    "id": 7,
    "name": "Suscriptores newsletter",
    "is_active": true,
    "channel": [
      "mail"
    ],
    "description": null,
    "created_at": "2026-10-01T12:00:00",
    "updated_at": "2026-10-01T12:00:00"
  }
],
"pagination": {
  "page": 1,
  "page_size": 20,
  "has_more": false,
  "total_items": 1,
  "total_pages": 1
}
}