Skip to main content
GET
List custom field definitions

Authorizations

Authorization
string
header
required

Query Parameters

page
integer<int32>
default:1

The page to return, starting at 1. A value below 1 or a non-numeric value returns 400.

Required range: x >= 1
page_size
integer<int32>
default:20

Rows per page, from 1 to 200. A value below 1 counts as 1 and a value above 200 as 200; a non-numeric value uses the default.

Required range: 1 <= x <= 200
project_id
string

The project's friendly ID (e.g. prj_aBcD1234eFgH5678). Widens the result to include that project's scoped definitions. A project outside the account returns 404.

object_type
enum<string>

Filter by the record type the definitions apply to. Any other value returns 422.

Available options:
project,
asset
sort
string

Sortable fields: id, key, label, object_type, value_type, order, created_at, updated_at.

Example:

"label"

fields
string

Comma-separated fields to return in each row. Other names are ignored.

response_mode
enum<string>

default returns a page of rows. summary returns the number of matching records and up to 10 sample rows. This endpoint doesn't support summary_with_export, which returns 400.

Available options:
default,
summary

Response

Paginated list. With response_mode=summary, a count and up to 10 samples instead.

data
object[]
required
info
object
required

Where this page sits in the full result, and the sort, filters and fields the request applied.