Read Custom Field
Intent
Reads the custom field without changing it.
When to call it
Call this after your application has received or stored the identifier for the custom field.
Access boundary
Authorize the request with a token that carries custom_fields:read or custom_fields:write.
Successful result
A successful request returns 200. The response schema below defines the body your integration receives.
Operational notes
Get a custom field by ID.
Scopes: custom_fields:read custom_fields:write
Authorizations
You can generate an Organization Access Token from your organization's settings.
Path Parameters
The custom field ID.
Response
Successful Response
- CustomFieldText
- CustomFieldNumber
- CustomFieldDate
- CustomFieldCheckbox
- CustomFieldSelect
Schema for a custom field of type text.
The time Ruba created this record.
The time this record last changed.
The stable identifier for this record.
"text"Identifier of the custom field. It'll be used as key when storing the value.
Name of the custom field.
The ID of the organization owning the custom field.
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"