Skip to main content
GET
/
custom_field_definitions
/
{id}
Retrieve a custom field definition
curl --request GET \
  --url https://app.supercycle.com/api/v1/custom_field_definitions/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": 123,
  "key": "<string>",
  "name": "<string>",
  "ownerType": "item",
  "type": "string",
  "groupFulfillments": true
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
integer
required

Numeric ID of the custom field definition.

Response

200 - application/json

Expected response to a valid request

​
id
integer<int64>
required

Numeric ID of the custom field definition.

​
key
string
required

Unique key identifier for the custom field.

​
name
string
required

Display name of the custom field.

​
ownerType
enum<string>
required

Type of resource this custom field applies to.

Available options:
item,
rental
​
type
enum<string>
required

Data type of the custom field value.

Available options:
string,
single_line_text_field,
money,
customer_reference,
rental_reference,
return_reference,
multi_line_text_field,
boolean,
date,
date_time
​
groupFulfillments
boolean
required

Whether this field groups fulfillments together.