Skip to content

Query Relationship Cells

POST
/objects/{object_slug}/relationships/cells

Relationship columns for a page of rows: up to two linked-record chips and the visible total per cell.

A read (POST only because the row ids travel in the body). Rows and far records the credential may not see contribute neither chips nor counts.

Authorizations

Parameters

Path Parameters

object_slug
required
string

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Rows on screen (canonical ids: contact/company PK, deal UUID, or custom record UUID) and the relationship columns shown for them.

object
definition_ids
required
Array<string>
>= 1 items <= 10 items
record_ids
required
Array<string>
>= 1 items <= 100 items

Responses

200

Successful Response

object
data
required

cells[record_id][definition_id]. A row the caller may not see, or a column whose far object the caller may not read, is absent rather than empty.

object
cells
required
object
key
additional properties
object
key
additional properties

Up to GRID_CELL_CHIPS linked records plus how many the caller may see in all. Far ends the caller may not read contribute neither a chip nor the total.

object
records
required
Array<object>
object
kind
required
string
label
required
Any of:
string
object_slug
required
string
record_id
required
string
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