Skip to main content
GET
List fields

Authorizations

Authorization
string
header
required

A workspace API token. Create one in Settings → API. Send it as Authorization: Bearer sk_live_....

Query Parameters

entity
string | null

Restrict to one resource: contact, organization or deal. Omit to list every field in the workspace.

limit
integer
default:50

Items per page (max 200).

Required range: 1 <= x <= 200
cursor
string | null

Opaque cursor from a previous response's links.next.

Response

Successful Response

A page of field definitions.

A named subclass purely so the generated SDK type is FieldList rather than the Page_PublicField_ FastAPI derives from the generic.

data
PublicField · object[]
required
meta
PageMeta · object
required