---
title: "Query Relationship Cells"
method: POST
path: "/objects/{object_slug}/relationships/cells"
tags: ["Objects"]
---

# Query Relationship Cells

`POST /objects/{object_slug}/relationships/cells`

## Request

- Base URL: `https://be.graph8.com/api/v1`
- URL: `https://be.graph8.com/api/v1/objects/{object_slug}/relationships/cells`
- Auth: HTTP bearer

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.

## Path parameters

- `object_slug` string, required

## Headers

- `Authorization` string, nullable
- `X-Target-Org-Id` string, nullable

## Request body

- RelationshipGridCellsQuery: Rows on screen (canonical ids: contact/company PK, deal UUID, or custom record UUID) and the relationship columns shown for them.
  - `record_ids` string[], required
  - `definition_ids` string[], required

## Response `200`

Successful Response

- ApiResponseRelationshipGridCellsResponse
  - `data` RelationshipGridCellsResponse, 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.
    - `cells` object, required
  - `pagination` PaginationMeta
    - `page` integer, required: Current page number (1-indexed)
    - `limit` integer, required: Items per page
    - `total` integer, required: Total number of items
    - `has_next` boolean, required: Whether there are more pages
    - `next_cursor` string, nullable: Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers.
    - `total_available` integer, nullable: Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search.
    - `total_is_lower_bound` boolean, nullable: Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search.
    - `notes` string[], nullable: Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order.

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/graph8/apis/graph8-developer-api.md) · [All operations](https://skmtc.dev/graph8/apis/graph8-developer-api/llms.txt) · [OpenAPI document](https://skmtc.dev/graph8/apis/graph8-developer-api/revisions/2e7cfa0ca921?raw)