List Contact Fields

Retrieve all contact fields available for your organisation — both built-in (default) fields from the Contact schema and custom attribute fields you have created. Useful for MCP clients and integrations that need to know what fields exist before reading or writing contact data.

GET/v2.0/contacts/fields

Query Parameters

Parameter	Type	Required	Description
type	string	Optional	Filter by field type. One of: "default" (built-in fields only), "custom" (custom attribute fields only), "all" (both)Default: `all`

Default Field Reference

These 19 fields are always present for every contact and cannot be deleted:

Field Key	Label	Field Type
phone	Phone	text
countryCode	Country Code	text
contactName	Contact Name	text
email	Email	text
platform	Platform	dropdown
businessName	Business Name	text
addressLine1	Address Line 1	text
addressLine2	Address Line 2	text
city	City	text
state	State	text
postalCode	Postal Code	text
country	Country	text
source	Source	text
notes	Notes	text
optedOut	Opted Out	boolean
lead_category	Lead Category	text
wa_undeliverable	WA Undeliverable	boolean
createdAt	Created At	date
updatedAt	Updated At	date

Code Examples

curl -X GET "https://api.sendiee.com/v2.0/contacts/fields" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response

{
  "success": true,
  "data": [
    {
      "key": "phone",
      "label": "Phone",
      "fieldType": "text",
      "type": "default"
    },
    {
      "key": "contactName",
      "label": "Contact Name",
      "fieldType": "text",
      "type": "default"
    },
    {
      "key": "email",
      "label": "Email",
      "fieldType": "text",
      "type": "default"
    },
    {
      "key": "platform",
      "label": "Platform",
      "fieldType": "dropdown",
      "options": [
        "whatsapp",
        "instagram",
        "messenger"
      ],
      "type": "default"
    },
    {
      "key": "optedOut",
      "label": "Opted Out",
      "fieldType": "boolean",
      "type": "default"
    },
    {
      "_id": "6640fa2b3e4a1c0012abc001",
      "fieldName": "Birthday",
      "fieldKey": "birthday",
      "fieldType": "date",
      "hasDropdown": false,
      "options": [],
      "createdAt": "2026-03-01T10:00:00.000Z",
      "updatedAt": "2026-03-01T10:00:00.000Z",
      "type": "custom"
    },
    {
      "_id": "6640fa2b3e4a1c0012abc002",
      "fieldName": "Lead Source",
      "fieldKey": "lead_source",
      "fieldType": "dropdown",
      "hasDropdown": true,
      "options": [
        "Facebook Ads",
        "Google Ads",
        "Organic",
        "Referral"
      ],
      "createdAt": "2026-03-05T08:00:00.000Z",
      "updatedAt": "2026-03-05T08:00:00.000Z",
      "type": "custom"
    }
  ],
  "meta": {
    "defaultCount": 19,
    "customCount": 2,
    "total": 21
  }
}

Try It

Try it — API Playground

API Key

Type

Filter by field type