Listar contactos de un dataset

GET/v1/datasets/{id}/records

Para desarrolladores

Descripción

Lista los contactos acumulados en un dataset, paginados. Cada registro trae sus valores indexados por la field_key del campo (GET /v1/fields).

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

Path params:

idintegerobligatorio

Identificador del dataset.

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 registro.

dataobjectsiempre presente

Valores del contacto, indexados por field_key, con el tipo de su campo: sí/no como booleano, selección múltiple como lista de opciones, número como número, fecha como texto YYYY-MM-DD y el resto como texto. Una columna declarada pero sin valor no aparece.

created_atstringsiempre presente

Fecha en que el contacto entró al dataset (ISO 8601, UTC).

Nota

has_more indica si hay otra página. total_items y total_pages vienen siempre en null. Para recorrer el dataset completo, avance de página mientras has_more sea true, o use GET /v1/datasets/{id}/records/export.

Errores

Código	code	Cuándo
404	dataset_not_found	El dataset no existe.

El catálogo completo está en Respuestas de error.

Notas

• created_at es cuándo entró, no cuándo se actualizó. Si un contacto vuelve a entrar, se le aplica la política de colisión del dataset sobre su mismo registro. No se crea uno nuevo.
• data puede traer una clave que el dataset ya no declara. Quitar una columna hace que deje de guardarse, pero no borra los valores que ya tenía.

Request

curl -X GET "https://cl1api.fidelizador.com/v1/datasets/7/records?page=1&page_size=20" \
-H "Authorization: Bearer <API_KEY>" \
-H "X-Instance-Slug: <slug>"

Response

{
"data": [
  {
    "id": 102,
    "data": {
      "EMAIL": "[email protected]",
      "FIRST_NAME": "Ana",
      "ACEPTA_NOVEDADES": true,
      "INTERESES": [
        "DEPORTE",
        "VIAJES"
      ],
      "HIJOS": 2
    },
    "created_at": "2026-10-01T12:00:00"
  }
],
"pagination": {
  "page": 1,
  "page_size": 20,
  "has_more": false,
  "total_items": null,
  "total_pages": null
}
}