Configuration APICustom Fields

Get a custom field by ID

Requires the CUSTOM_FIELD.VIEW permission.

Authentication

X-API-KEYstring
API Key authentication via header
OR
AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

versionstringRequiredDefaults to 1
version
resourceIdstringRequiredDefaults to
The ID of the resource to be requested.

Headers

x-platform-idstringOptional
Platform ID.

Response

OK
object_typestring or nullOptionalRead-only
idstring or nullOptionalRead-only
referencestringOptionalformat: "^\S+$"0-256 characters
namestring or nullOptional
descriptionstring or nullOptional
resource_typeenumOptional
multiple_valuesboolean or nullOptional
unique_valueboolean or nullOptional
copy_value_to_invoiceboolean or nullOptional
integration_idstringOptional
The resource ID of the integration linked to this custom field.
integration_referencestring or nullOptionalRead-only

The reference of the integration linked to this custom field. Read-only, and only present when the custom field is linked to an integration.

integration_typestring or nullOptionalRead-only

The type of the integration linked to this custom field. Read-only, and only present when the custom field is linked to an integration.

typeenum or nullOptional
Allowed values:
enum_valueslist of strings or nullOptional

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
409
Conflict Error
500
Internal Server Error