latestOpenAPI 3.0.02026-08-1284111344.5 KB

14666f4db0f8

Custom Fields

Retrieve a list of Custom Fields

Retrieves a paginated list of Custom Fields, optionally filtered by entity type.

get/v2/customfields

Query parameters

pageSizenumber

Example:10

Number of records to return per page.

pagenumber

Example:1

The page index.

entityType'JOB' | 'CLIENT'

Filter results by the entity the custom field belongs to.

Headers

Authorizationstring required

Example:Bearer <token>

Bearer Token

Response

A paginated list of Custom Fields.

pageSizenumber

The maximum number of items returned per page.

pagenumber

The current page number.

totalResultsnumber

The total number of results.

hasMoreboolean

Whether there are more results.

Example response

{
  "pageSize": 10,
  "page": 1,
  "totalResults": 50,
  "hasMore": true,
  "data": [
    {
      "id": "CF-eYLPK7198xVp6Z8q",
      "entityType": "JOB",
      "name": "Custom Field 1",
      "type": "Text",
      "groupId": "CFG-eYLPK7198xVp6Z8q",
      "jobTypes": [
        {
          "id": "JT-8718036049ec4c4d",
          "name": "Repair"
        }
      ],
      "options": [
        "option 1",
        "option 2",
        "option 3"
      ],
      "position": 1
    }
  ]
}