Skip to navigation

List data-object definitions

View as Markdown

Lists the org-level data-object definitions (the schemas that objects conform to: fields, types, groups, labels). Authorization: any authenticated org member (no role gate). Query: archived — pass true to include soft-archived definitions; omitted or false returns only active ones. Returns { definitions: [...] }; each definition carries _id, nameSingular/namePlural, labels, fields[], fieldGroups[], and version.

Authentication

AuthorizationBearer

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

Query parameters

archivedenumOptional

Pass true to include soft-archived definitions. Omitted or false returns only active ones.

Allowed values:

Response

The definitions.
definitionslist of objects