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ón | Este endpoint |
|---|---|
OWNER | Permitido |
ADMIN | Permitido |
MEMBER | Permitido |
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
| Campo | Tipo | Descripción |
|---|---|---|
success | boolean | Indica si la operación tuvo éxito |
data | array | Los campos personalizados |
data[].id | string | Identificador único: el customFieldId de las llamadas de renombrado y eliminación |
data[].key | string | La clave bajo la que se escriben los valores, única en la organización. Nunca cambia |
data[].label | string | El nombre que se lee |
data[].type | string | text, number, date o boolean (sí/no). Nunca cambia |
data[].createdAt | string | Fecha de creación ISO |
data[].updatedAt | string | Fecha 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.