v1

latestOpenAPI 3.0.0Proprietary2026-07-26130282259.8 KB

contacts

Get Contact Custom Fields

Get a list of all custom fields related to a specific contact by its contact Id. This endpoint will return a paginated response starting from the given record index. StartIndex starts at 0. Default PageSize is 25. Pagination parameters are optional.

get/contacts/{contactId}/custom-fields

Path parameters

contactIdstring uuid required

The contact's unique identifier

Query parameters

pageSizeinteger

Controls how many items are returned per page in paginated responses.

Default: 25 items per page if not specified
Minimum: 1 item per page
Use with pageStartIndex for navigating through large result sets

recordStartIndexinteger

The index of the first element to return

Response

A list of custom fields objects

countinteger

The total number of items available across all pages. Use this to calculate the total number of pages available.

pageSizeinteger

The number of items per page in this response. This reflects either your requested page size or the default value.

pageStartIndexinteger

The starting index of this page of results. Use with pageSize to track your position in the overall result set.

Example response

{
  "items": [
    {
      "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"
    }
  ]
}