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

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
limit
integer<int32>

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 50.

Required range: x <= 100
​
page
string

Cursor token to fetch next page of results.

​
owner_type
enum<string>
required

Filter definitions by owner type (required)

Available options:
item,
rental

Response

A paged array of custom field definitions

​
data
object[]
​
nextPage
null | string