List All Fields

Retrieve all contact fields defined in your workspace. Fields represent the data schema for contacts and are referenced by their merge_tag when creating or updating contacts.

---

Endpoint

GET https://api.campaignlark.com/v1/fields

---

Request

This endpoint accepts no query parameters or request body.

---

Response

Success — 200 OK

{
  "data": [
    {
      "id": 1,
      "label": "Email Address",
      "merge_tag": "email_address",
      "type": "TEXT",
      "definition": "",
      "default_value": "",
      "order": 0,
      "immutable": true,
      "required": true
    },
    {
      "id": 2,
      "label": "First Name",
      "merge_tag": "first_name",
      "type": "TEXT",
      "definition": "",
      "default_value": "",
      "order": 1,
      "immutable": false,
      "required": false
    }
  ]
}

Response Fields

Field	Type	Description
id	integer	Unique identifier for the field.
label	string	Human-readable display name for the field.
merge_tag	string	The key used to reference this field in contact data payloads (e.g. email_address).
type	string	Data type of the field. See Field Types below.
definition	string	Additional field configuration (e.g. options for multi-select fields).
default_value	string	Value used when no value is provided for this field.
order	integer	Display order of the field.
immutable	boolean	If true, this field cannot be deleted or renamed. System fields such as email_address are immutable.
required	boolean	If true, this field must have a value on every contact.

Field Types

Value	Description
TEXT	Plain text string.
NUMBER	Numeric value.
BOOL	Boolean (true / false).
DATE	Date value in RFC 3339 format.
MULTI	Multi-select; valid options are defined in definition.