WOworkiz
Custom Fields

Retrieve a single Custom Field

Changed on

Retrieves a single Custom Field by its ID.

get/v2/customfields/{id}

Request

Path parameters

idstring required
Example:CF-eYLPK7198xVp6Z8q

The custom field ID (prefix CF-).

Headers

Authorizationstring required
Example:Bearer <token>

Bearer Token

Response

The requested Custom Field.

idstring

The ID of the custom field (prefix CF-).

entityType'JOB' | 'CLIENT'

The entity type of the custom field.

namestring

The name of the custom field.

type'Text' | 'Number' | 'Date' | 'Drop Down' | 'Checkbox' | 'Large Text' | 'File Upload'

The type of the custom field.

optionsstring[]

The options of the custom field.

positionnumber

The position of the custom field.

requiredboolean

Indicates whether the custom field is required or not. (job only)

requiredCloseboolean

Indicates whether the custom field is required to close the job. (job only)

searchableboolean

Indicates whether the custom field is searchable or not.

Example response

{
  "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 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