Skip to main content

Get Field

Retrieve a single contact field by its ID.


Endpoint

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

Path Parameters

ParameterTypeRequiredDescription
idintegerrequiredThe field ID.

Sample Request

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

Response

Success — 200 OK

{
"data": {
"id": 2,
"label": "First Name",
"merge_tag": "first_name",
"type": "TEXT",
"definition": "",
"default_value": "",
"order": 20,
"immutable": false,
"required": false
}
}

Errors

StatusMessageCause
404We were unable to find the field.Field does not exist in this workspace.