Sign in

v1

latestOpenAPI 3.0.0Proprietary2026-07-26130282259.8 KB
company

Get Custom Field Definitions

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.

get/company-settings/custom-fields

Query parameters

filter'jobs' | 'contacts'

Filter custom field definitions by type. When not specified, returns both job and contact custom field definitions.

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

includesstring

Optional fields to include in full with the response.

Response

OK

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": "e5e7f960-f4c3-481d-93d3-0fc2b44efa41",
      "_link": "https://api.acculynx.com/api/v2/company-settings/custom-fields/e5e7f960-f4c3-481d-93d3-0fc2b44efa4",
      "label": "Customer Preference",
      "isActive": true,
      "options": [
        {
          "id": "a1b2c3d4-5e6f-7890-abcd-ef1234567890",
          "value": "option_1",
          "isActive": true,
          "sortOrder": 1
        }
      ],
      "modifiedBy": {
        "id": "228db892-3b49-4455-b839-ffd8576d8731",
        "_link": "https://api.acculynx.com/api/v2/users/228db892-3b49-4455-b839-ffd8576d8731"
      },
      "modifiedDate": "2023-07-29T17:48:59Z",
      "createdDate": "2023-07-29T17:48:59Z"
    }
  ]
}