---
title: "Get Custom Field Definitions"
method: GET
path: "/company-settings/custom-fields"
tags: ["company"]
---

# Get Custom Field Definitions

`GET /company-settings/custom-fields`

Use this endpoint to retrieve custom field definitions and the options related to each custom field definition by company.
Returns Custom Field Definitions for types "contact" and "job" with only active status.
Includes field options with active status by default.
Custom Field Definitions are returned by grouped by field type.
StartIndex starts at 0. Default PageSize is 25. Pagination parameters are optional.
You can filter by type 'jobs' or 'contacts'. By default both filters are included. `e.g. ?filter=jobs`.
**Supported includes:** `user`.

## Query parameters

- `filter` 'jobs' | 'contacts'
- `pageSize` integer
- `recordStartIndex` integer
- `includes` string

## Response `200`

OK

- CustomFieldDefinitionsCollection — 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` CustomFieldDefinitionFull[]
    - `id` string, uuid — The unique identifier of the custom field definition.
    - `_link` string — The unique URI of the custom field definition.
    - `label` string — The display label of the custom field definition.
    - `entityType` 'contact' | 'job' — Specifies the entity type (job, contact) for the custom field.
    - `fieldType` 'Text' | 'Number' | 'Date' | 'Boolean' — Specifies the data type (text, number, date, boolean) for the custom field.
    - `isActive` boolean — Whether the custom field definition is active.
    - `options` CustomFieldOption[] — The available options for dropdown-type custom fields.
      - `id` string, uuid — The unique identifier of the custom field option.
      - `value` string — The value of the custom field option.
      - `isActive` boolean — Whether the custom field option is active.
      - `sortOrder` integer — The sort order of the custom field option.
    - `modifiedBy` CompanyUserLink
      - `id` string, uuid — The unique GUID of the AccuLynx User.
      - `_link` string — The unique URI of the AccuLynx User.
    - `modifiedDate` string, date-time — The date/time the custom field definition was last modified, in UTC format.
    - `createdDate` string, date-time — The date/time the custom field definition was created, 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.
- `416` — Range Not Satisfiable - The requested page of results is not available. Common causes: - pageStartIndex is beyond the available data range - Invalid pagination parameters

---

[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)