ACacculynx
company

Get Custom Field Definitions

Changed on

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. This endpoint will return a paginated response starting from the given page start index. pageStartIndex starts at 0. Default pageSize is 25. Pagination parameters are optional. A 416 Range Not Satisfiable error is returned when pageStartIndex is greater than or equal to the total number of custom field definitions (after filtering). The error message includes the total result count. When there are no custom field definitions (after filtering), a 200 OK is returned with an empty items array, echoing back the requested pageSize and pageStartIndex. 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

Request

  • Base URL
    https://api.acculynx.com/api/v2
  • URL
    https://api.acculynx.com/api/v2/company-settings/custom-fields
  • Auth
    HTTP bearer

Query parameters

filter'jobs' | 'contacts'

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

pageSizeinteger

How many items to be returned at a time.

pageStartIndexinteger

The value of pageStartIndex will specify the index of the record that the list begins with.

includesstring

A comma-separated list of related resources to expand inline in the response. Valid values vary by endpoint and are documented in each operation description.

Response

OK

countinteger

The total number of items matching the current query.

pageSizeinteger

The requested or default page size.

pageStartIndexinteger

The requested or default index of the first element to return.

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"
    }
  ]
}

Changes

  • 443924b00f43Revision changes
    • breaking

      for the query request parameter pageSize, default value 25 was removed

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • warning

      deleted the query request parameter recordStartIndex

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      added the new optional query request parameter pageStartIndex

    • info

      added the optional property to the response with the status