v1

latestOpenAPI 3.0.0Proprietary2026-07-26130282259.8 KB

contacts

Get Contact Custom Field

Get a custom field object inside a contact provided a custom field id and a valid contact id

get/contacts/{contactId}/custom-fields/{customFieldId}

Path parameters

contactIdstring uuid required

The contact's unique identifier

customFieldIdstring uuid required

The ID of the custom field

Response

A custom field object

idstring uuid

_linkstring

The unique URI of the AccuLynx custom field value.

labelstring

fieldType'Text' | 'Number' | 'Date' | 'Boolean'

Specifies the data type (text, number, date, boolean) for the custom field.

modifiedDatestring

The date/time the custom field was modified, in UTC format.

Example response

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "_link": "https://api-acculynx.com/api/v2/jobs/f4b85772-398d-4e2a-aba7-edbde6cf73fa/custom-fields/3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "customFieldDefinition": {
    "id": "e5e7f960-f4c3-481d-93d3-0fc2b44efa41",
    "_link": "https://api-acculynx.com/api/v2/company-settings/job-file-settings/custom-fields/e5e7f960-f4c3-481d-93d3-0fc2b44efa41"
  },
  "label": "Custom Field 1",
  "values": [
    {
      "id": "228db892-3b49-4455-b839-ffd8576d8731",
      "value": "White Roof"
    }
  ],
  "modifiedBy": {
    "id": "228db892-3b49-4455-b839-ffd8576d8731",
    "_link": "https://api.acculynx.com/api/v2/users/228db892-3b49-4455-b839-ffd8576d8731"
  },
  "modifiedDate": "2015-07-29T17:48:59Z"
}