WOworkiz
Custom Fields

Retrieve a list of Custom Fields

Changed on

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

get/v2/customfields

Request

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

Changes

  • a2110eaa32f2Revision changes
    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status