---
title: "Get Contact Custom Fields"
method: GET
path: "/contacts/{contactId}/custom-fields"
tags: ["contacts"]
---

# Get Contact Custom Fields

`GET /contacts/{contactId}/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.

## Path parameters

- `contactId` string, uuid, required

## Query parameters

- `pageSize` integer
- `recordStartIndex` integer

## Response `200`

A list of custom fields objects

- CustomFieldsCollection — Base structure for all paginated collection responses. This provides consistent pagination metadata across all collection endpoints.
  - `count` integer — The total number of items available across all pages. Use this to calculate the total number of pages available.
  - `pageSize` integer — The number of items per page in this response. This reflects either your requested page size or the default value.
  - `pageStartIndex` integer — The starting index of this page of results. Use with pageSize to track your position in the overall result set.
  - `items` CustomField[]
    - `id` string, uuid
    - `_link` string — The unique URI of the AccuLynx custom field value.
    - `customFieldDefinition` CustomFieldDefinition
      - `id` string, uuid — The unique unique identifier of the AccuLynx custom field.
      - `_link` string — The unique URI of the AccuLynx custom field.
    - `label` string
    - `fieldType` 'Text' | 'Number' | 'Date' | 'Boolean' — Specifies the data type (text, number, date, boolean) for the custom field.
    - `values` CustomFieldValueItem[]
      - `id` string, uuid — The unique identifier of the AccuLynx custom field item.
      - `value` string — The item value of the custom field
    - `modifiedBy` CompanyUserLink
      - `id` string, uuid — The unique GUID of the AccuLynx User.
      - `_link` string — The unique URI of the AccuLynx User.
    - `modifiedDate` string — The date/time the custom field was modified, in UTC format.

## Other responses

- `400` — Bad Request - The server cannot process the request due to a client error. Common causes: - Invalid request format - Missing required fields - Validation errors in the request data
- `401` — Unauthorized - Authentication is required or has failed. Common causes: - Missing API key - Invalid API key - Expired or deactivated API key
- `403` — Not enough permissions.
- `404` — Not Found - The requested resource does not exist. Common causes: - Invalid subscription ID - Subscription has been deleted - URL path contains typos or incorrect values

---

[API](https://skmtc.net/acculynx/apis/acculynx-api-v2.md) · [All operations](https://skmtc.net/acculynx/apis/acculynx-api-v2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/acculynx/acculynx-api-v2/versions/3a9e3886e400/schema)