List custom fields

GET https://app.sendapp.ai/api/contact-fields

Returns your account's custom contact fields (Custom fields page), in the order you see them on the page. Use a field's name to write its value on a contact with custom_fields in Update contact.

Available types: input, textarea, number, date, select, multiselect, boolean, url, phone, email, ai. options is set only for select and multiselect, ai_prompt only for ai.

Common errors: 401 if the API key is missing or wrong — 403 if the plan has expired or does not include API access — 429 if you send too many requests in a short time: try again after a few seconds.

Parameters

1 · 1 required

apikey required

Your API Key (the X-API-Key header also works).

Need help with the integration? info@sendapp.live

Request

curl 'https://app.sendapp.ai/api/contact-fields' \
  -H 'X-API-Key: YOUR_API_KEY'

<?php
$ch = curl_init('https://app.sendapp.ai/api/contact-fields');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => ['X-API-Key: YOUR_API_KEY'],
]);
echo curl_exec($ch);
curl_close($ch);

const res = await fetch('https://app.sendapp.ai/api/contact-fields', {
  headers: { 'X-API-Key': 'YOUR_API_KEY' }
});
console.log(await res.json());

Response

{
  "status": "success",
  "total": 2,
  "types": ["input", "textarea", "number", "date", "select", "multiselect", "boolean", "url", "phone", "email", "ai"],
  "fields": [
    {
      "id": 12,
      "name": "City",
      "type": "input",
      "options": null,
      "ai_prompt": null,
      "show_in_list": true,
      "visible_to_ai": true,
      "is_required": false,
      "sort_order": 0,
      "created_at": "2026-10-29 10:00:00",
      "updated_at": "2026-10-29 10:00:00"
    },
    {
      "id": 13,
      "name": "Size",
      "type": "select",
      "options": ["S", "M", "L"],
      "ai_prompt": null,
      "show_in_list": false,
      "visible_to_ai": true,
      "is_required": true,
      "sort_order": 1,
      "created_at": "2026-10-29 10:05:00",
      "updated_at": "2026-10-29 10:05:00"
    }
  ]
}

{
  "status": "error",
  "message": "Your current plan does not include API access."
}