Listar los campos personalizados

GET /api/v1/custom-fields Cada campo personalizado de la organización. Léelo antes de escribir customFields en un contacto: solo se aceptan las claves listadas aquí. La lista es completa: no hay paginación ni búsqueda; una organización tiene como máximo 50 campos.

Autorización

Rol en la organizaciónEste endpoint
OWNERPermitido
ADMINPermitido
MEMBERPermitido
Una clave lleva el rol que su creador tiene en esta organización, nunca un rol sobre AgentsMail en sí. Consulta Claves de API.

Ejemplo

bash
curl -H "x-api-key: $AGENTMAIL_API_KEY" \
  "https://www.agentsmail.io/api/v1/custom-fields"

Respuesta

  • 200 OK: los campos personalizados, del más antiguo al más reciente. Una organización sin ninguno responde un array vacío.
  • 401 Unauthorized: clave ausente o no válida, o su propietario salió de la organización.
  • 429 Too Many Requests: más de 120 solicitudes en un minuto para esta clave.

Campos de la respuesta

CampoTipoDescripción
successbooleanIndica si la operación tuvo éxito
dataarrayLos campos personalizados
data[].idstringIdentificador único: el customFieldId de las llamadas de renombrado y eliminación
data[].keystringLa clave bajo la que se escriben los valores, única en la organización. Nunca cambia
data[].labelstringEl nombre que se lee
data[].typestringtext, number, date o boolean (sí/no). Nunca cambia
data[].createdAtstringFecha de creación ISO
data[].updatedAtstringFecha ISO del último cambio

Ejemplo de respuesta

json
{
  "success": true,
  "data": [
    {
      "id": "4f1a9c2e",
      "key": "utm_source",
      "label": "UTM source",
      "type": "text",
      "createdAt": "2026-11-02T08:11:00.000Z",
      "updatedAt": "2026-11-02T08:11:00.000Z"
    }
  ]
}

Notas

  • Ni ?search= ni paginación aquí. La lista entera llega en una llamada: busca la clave por tu lado.

Relacionado