latestOpenAPI 3.0.02026-08-10416661.5 MB

e96b3e58b041

Contacts

Get contact's custom fields

REQUIRED SCOPES <code>['contacts:read']</code><br> This request fetches properties of all the fields of a particular contact matching the required id, including custom fields. The endpoint offers the mechanism of creating and adding any custom field, such as city, to the system.<br><br> Each contact has four fields by defaut:<ul><li>First name</li><li>Last name</li><li>Email</li><li>Phone number</li></ul>

get/contacts/custom-fields/{contact}

Path parameters

contactinteger required

ID of contact

Response

OK

Example response

{
  "data": [
    {
      "id": 1,
      "name": "Age",
      "field_key": "custom.age",
      "type": "number",
      "value": {
        "type": "number",
        "value": "30"
      }
    }
  ]
}