List custom fields

Returns every custom field (CRM column) in the workspace, with the ids you need for Create or update a contact.

GET

https://api.zacx.io/v1/customFields

View as Markdown

Authorisation

bearerAuthHTTPrequired

Returns

200

The custom fields. data is empty when none are configured.

JSON

statusstringrequired
dataarray ofobjectrequired
3 properties
- idstringrequired
  format: uuid
- namestringrequired
  Example: "test field"
- typestringrequired
  Field type as configured in the CRM.
  
  Example: "single_line"
messageoptionalstring
Present only when the workspace has no custom fields.

List custom fields

curl --request GET \
  --url https://api.zacx.io/v1/customFields \
  --header 'Authorization: Bearer <token>'

const url = 'https://api.zacx.io/v1/customFields';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

Response example

{
  "status": "success",
  "data": [
    {
      "id": "c79996c1-af9f-4353-810f-153417ec34cf",
      "name": "test field",
      "type": "single_line"
    }
  ]
}