Skip to main content
GET
List every field definition on an object (the describe API)

Authorizations

Authorization
string
header
required

An API key, sent as Authorization: Bearer stfy_live_…. See Authentication for how to get one and which scopes it needs.

Query Parameters

object
string
required

The object the field belongs to: one of account, activity, contact, opportunity, project, task, user, or a custom object's key (GET /v1/objects lists them)

kind
enum<string> | null

Only standard or only custom fields

Available options:
standard,
custom
search
string | null

Only fields whose key or label contains this text

Required string length: 1 - 200
keys
string[] | null

Only these keys, comma-separated (keys=a,b)

Response

200 - application/json

Successful Response

fields
FieldDef · object[]
required
object
string
required
relationships
RelationshipDef · object[]