---
title: "Read Session Grid"
method: POST
path: "/dialer/sessions/{session_id}/grid"
tags: ["Dialer"]
---

# Read Session Grid

`POST /dialer/sessions/{session_id}/grid`

## Request

- Base URL: `https://be.graph8.com/api/v1`
- URL: `https://be.graph8.com/api/v1/dialer/sessions/{session_id}/grid`
- Auth: HTTP bearer

CONTACTS NOBODY. Reads a page of the session's contact grid.

A POST because the filter and sort specification is too large for a query
string, not because it changes anything - it mutates nothing and dials
nobody. Tiered `read` by an explicit rule for that reason, so a read-only
key can page through a queue.

## Path parameters

- `session_id` string, required: Session id.

## Headers

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

## Request body

- GridPageRequest: Mirrors `GridPageRequest`. A read - it paginates the queue grid.
  - `offset` integer
  - `limit` integer
  - `filter_spec` FilterSpec: Which contacts in the list are eligible to be dialed. Narrowing this on a RUNNING session changes who gets called next. It is not a display filter.
    - `search` string, nullable
    - `predicates` FilterPredicate[]
      - `field` string, required
      - `op` string, required
      - `value` unknown
      - `values` unknown[], nullable
        - unknown
      - `conditions` object[], nullable: Nested predicates for AND/OR groups. Each entry has the same shape as this object: field, op, value, values and, optionally, its own conditions.
    - `exclude_dispositions` string[]
  - `order_spec` OrderSpec: The order the queue is worked in, and which phone field is tried first.
    - `mode` 'natural_skip_dialed' | 'dialed_first'
    - `phone_priority` string[]
    - `sort_model` object[]
  - `sort_model` object[], nullable
  - `valid_phones_only` boolean
  - `include_contact_data` boolean

## Response `200`

Successful Response

- ApiResponseDialerListPayload
  - `data` DialerListPayload, required: An open envelope for a LIST result, so a bare list keeps its shape.
    - `items` unknown[]
      - unknown
  - `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)