Listar las columnas de una lista

GET/v1/lists/{id}/fields

Para desarrolladores

Descripción

Devuelve las columnas declaradas de una lista, en el orden del CSV, con el campo del catálogo que corresponde a cada una.

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 todas las columnas en data, en una sola página. Cada elemento tiene los campos que siguen.

field_idintegersiempre presente

Campo del catálogo (`GET /v1/fields`).

field_keystringsiempre presente

Clave del campo en el catálogo.

namestringsiempre presente

Nombre visible del campo.

typestring, enum: `email | phone | text | textarea | number | date | select | multiselect | boolean | url | address`siempre presente

Tipo del campo; decide cómo se interpreta la columna al importar.

csv_posinteger | nullsiempre presente

Posición de la columna en el CSV, contando desde 1.

is_requiredbooleansiempre presente

La importación descarta las filas sin valor en esta columna.

is_uniquebooleansiempre presente

La importación no admite dos filas con el mismo valor en esta columna.

unique_actionstring, enum: `error | ignore | update`siempre presente

Qué hace la importación con una fila que repite el valor de una columna única. Ver `PUT /v1/lists/{id}/fields`.

Errores

Código	Cuándo
404	La lista no existe o fue eliminada (list_not_found).

Request

curl -X GET "https://$API_HOST/v1/lists/4/fields" \
-H "Authorization: Bearer $API_KEY" \
-H "X-Instance-Slug: $SLUG"

Response

{
"data": [
  {
    "field_id": 1,
    "field_key": "EMAIL",
    "name": "Email",
    "type": "email",
    "csv_pos": 1,
    "is_required": true,
    "is_unique": true,
    "unique_action": "update"
  },
  {
    "field_id": 12,
    "field_key": "PLAN",
    "name": "Plan",
    "type": "text",
    "csv_pos": 2,
    "is_required": false,
    "is_unique": false,
    "unique_action": "error"
  }
],
"pagination": {
  "page": 1,
  "page_size": 2,
  "has_more": false,
  "total_items": 2,
  "total_pages": 1
}
}