Get Custom Field By ID

Retrieves the details of a custom field using its unique custom field ID.
Custom fields can be created from My Settings > Custom Fields > Add Custom Field in the platform settings

SecuritybearerAuth
Request
path Parameters
customFieldId
required
string

The unique identifier of the custom field to retrieve.

Example: mMa0VjWvqbk8
Responses
200

Requested Custom Field has been retrived successfully.

400

Invalid request.

401

The request could not be authorized.

500

The request could not be completed due to an internal error.

get/api/v1/customfields/{customFieldId}
Request samples 
Response samples 
application/json
{
  • "customFieldId": "mMa0VjWvqbk8",
  • "name": "Shelf#",
  • "customFieldType": "CHECKBOX",
  • "defaultValue": "top",
  • "status": "ACTIVE",
  • "archived": false,
  • "values": "Male",
  • "assignPageForm": [
    ]
}