Sign in

v1

latestOpenAPI 3.1.12026-07-24260246894.7 KB
Custom Fields

Retrieve custom field

Endpoint for retrieving a single custom field.

get/custom-fields/{id}/

Path parameters

idstring required

A unique value identifying this custom field.

Response

apply_toApplyToEnum[] required

The groups this custom field applies to.

created_tsstring date-time required

The timestamp in UTC when the custom field was created.

field_type'TEXT' | 'LONG_TEXT' | 'NUMBER' | 'DATE' | 'SELECT' | 'LOOKUP' | 'CALCULATED' required
  • TEXT - TEXT
  • LONG_TEXT - LONG_TEXT
  • NUMBER - NUMBER
  • DATE - DATE
  • SELECT - SELECT
  • LOOKUP - LOOKUP
  • CALCULATED - CALCULATED

Full information for FieldTypeEnum

idstring required

The unique identifier of the custom field.

is_activeboolean
is_line_item_fieldboolean
modified_tsstring date-time required

The timestamp in UTC when the custom field was last modified.

namestring
name_arstring