BIbigchange
Custom Fields

Get a list of custom field definitions

Changed on

Retrieves a paged collection of custom field definitions, optionally filtered by entity type (required scope customfields:read)

get/v1/customFields

Request

  • Base URL
    https://api.bigchange.com
  • URL
    https://api.bigchange.com/v1/customFields
  • Auth
    HTTP bearer

Query parameters

entityTypestring
Example:Job

Only return custom field definitions for this entity type. Returns all entity types when omitted

includeInactiveboolean

Whether to include inactive (soft-deleted) custom field definitions

pageNumberinteger

The page number being requested (minimum: 1, maximum: 2147483)

pageSizeinteger

The page size being requested (minimum: 1, maximum: 1000)

Headers

Customer-Idinteger required

The customer identifier

Response

OK

pageNumberinteger

The page number of the response where 1 is the first page

pageSizeinteger

The number of items requested for the current page

pageItemCountinteger

The number of items returned in the current page

totalCountinteger

The total number of custom field definitions matching the filter, across all pages

Example response

{
  "items": [
    {
      "id": 1234,
      "name": "Preferred contact time",
      "entityType": "contact",
      "fieldType": "text",
      "displayOrder": 1,
      "allowedValues": [
        {
          "id": 1,
          "value": "Red"
        }
      ]
    }
  ],
  "pageNumber": 2,
  "pageSize": 100,
  "pageItemCount": 55,
  "totalCount": 230
}

Changes