Retrieve a custom field

SecurityAuthToken

Request

path Parameters

companyId required	string <uuid> The id of the company
customFieldId required	string <uuid> The id of the custom field

Responses

200

Successfully returned the specified custom field

Response Schema: application/json

allow_carrier_edit	boolean
allow_carrier_view	boolean
	Array of objects (CustomFieldAllowedValue)
company	string or null <uuid>
created_at	string or null <date-time>
default_value	string or null
display_order required	integer <int32>
entity_types	Array of strings Items Enum: "purchase_order" "purchase_order_line_item" "purchase_order_stop" "shipment" "customer" "shipment_line_item" "shipment_stop" "shipment_charge_line_item"
field_type required	string Enum: "STRING" "BOOLEAN" "DATETIME" "SELECTION"
id	string or null <uuid>
key	string
label required	string
name required	string
required	boolean
ui_enabled	boolean Default: true
updated_at	string or null <date-time>

default

Default error response

get/companies/{companyId}/custom-fields/{customFieldId}/

Request samples

curl
Node.js
JavaScript
Python
Java

Response samples

200
default

application/json

{"allow_carrier_edit": true,
"allow_carrier_view": true,
"allowed_values": [{"created_at": "2019-08-24T14:15:22Z",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"label": "string",
"updated_at": "2019-08-24T14:15:22Z",
"value": "string"
}
],
"company": "87340f10-f684-4b06-8427-5981380bd9a9",
"created_at": "2019-08-24T14:15:22Z",
"default_value": "string",
"display_order": 0,
"entity_types": ["purchase_order"
],
"field_type": "STRING",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"key": "string",
"label": "string",
"name": "string",
"required": true,
"ui_enabled": true,
"updated_at": "2019-08-24T14:15:22Z"
}