Skip to content

Get Object Relationship Definitions

GET
/objects/{object_slug}/relationships

Definitions involving a custom or native object, narrowed to the credential’s native read scopes. include_archived lists archived definitions too.

Authorizations

Parameters

Path Parameters

object_slug
required
string

Query Parameters

limit
integer
default: 50 >= 1 <= 100
offset
integer
<= 10000
include_archived

Also list archived definitions (is_archived true).

boolean

Also list archived definitions (is_archived true).

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

object
data
required
object
relationships
required
Array<object>
object
api_slug
required
string
created_at
required
string format: date-time
id
required
string format: uuid
is_archived
required
boolean
revision
required
integer
source_kind
required
string
source_label
required
string
source_many
required
boolean
source_object_definition_id
required
Any of:
string format: uuid
target_kind
required
string
target_label
required
string
target_many
required
boolean
target_object_definition_id
required
Any of:
string format: uuid
total
required
integer
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string