List Objects

GET

/objects

• Production
• QA

PREVIEW. This endpoint is deployed but gated: it returns 404 unless the hosted app platform is enabled for your organization. It is published here so the contract describes the whole surface, not so it can be called today.

List accessible registered standard and custom objects; optionally include archived custom definitions.

Authorizations

• BearerAuth

Parameters

Query Parameters

include_archived

boolean

Header Parameters

X-Target-Org-Id

Any of:

string

string

null

null

Responses

200

Successful Response

object

data

required

Array<object>

One custom object type in the caller’s workspace.

object

description

Any of:

string

string

null

null

display_attribute_slug

Any of:

string

string

null

null

icon

Any of:

string

string

null

null

is_archived

Archived objects are hidden from listings.

boolean

is_system

True for objects graph8 ships; system objects cannot be deleted.

boolean

plural_noun

required

Display name for many records, e.g. “Invoices”.

string

singular_noun

required

Display name for one record, e.g. “Invoice”.

string

slug

required

Stable API slug for the object type, e.g. invoices.

string

pagination

Any of:

PaginationMeta

object

has_next

required

Whether there are more pages

boolean

limit

required

Items per page

integer

next_cursor

Any of:

string

string

null

null

notes

Any of:

Array<string>

Array<string>

null

null

page

required

Current page number (1-indexed)

integer

total

required

Total number of items

integer

total_available

Any of:

integer

integer

null

null

total_is_lower_bound

Any of:

boolean

boolean

null

null

null

null

422

Validation Error

object

detail

Array<object>

object

loc

required

Array

msg

required

string

type

required

string