GET /api/v1/custom-fields
Chaque champ personnalisé de l'organisation. Lisez-le avant d'écrire customFields sur un contact : seules les clés listées ici sont acceptées.
La liste est complète : ni pagination ni recherche — une organisation a au plus 50 champs.
Autorisation
| Rôle dans l'organisation | Cet endpoint |
|---|---|
OWNER | Autorisé |
ADMIN | Autorisé |
MEMBER | Autorisé |
Exemple
bash
curl -H "x-api-key: $AGENTMAIL_API_KEY" \
"https://www.agentsmail.io/api/v1/custom-fields"Réponse
200 OK— les champs personnalisés, du plus ancien au plus récent. Une organisation qui n'en a aucun répond un tableau vide.401 Unauthorized— clé absente ou invalide, ou son propriétaire a quitté l'organisation.429 Too Many Requests— plus de 120 requêtes en une minute pour cette clé.
Champs de la réponse
| Champ | Type | Description |
|---|---|---|
success | boolean | Indique si l'opération a réussi |
data | array | Les champs personnalisés |
data[].id | string | Identifiant unique — le customFieldId des appels de renommage et de suppression |
data[].key | string | La clé sous laquelle s'écrivent les valeurs, unique dans l'organisation. Ne change jamais |
data[].label | string | Le nom que l'on lit |
data[].type | string | text, number, date ou boolean (oui/non). Ne change jamais |
data[].createdAt | string | Date de création ISO |
data[].updatedAt | string | Date ISO de la dernière modification |
Exemple de réponse
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"
}
]
}Remarques
- Ni
?search=ni pagination ici. La liste entière revient en un appel — cherchez une clé de votre côté.