---
title: "List Plan Batches"
method: GET
path: "/mailboxes/schedule-buy/plans/{plan_id}/batches"
tags: ["Schedule Buy"]
---

# List Plan Batches

`GET /mailboxes/schedule-buy/plans/{plan_id}/batches`

## Request

- Base URL: `https://be.graph8.com/api/v1`
- URL: `https://be.graph8.com/api/v1/mailboxes/schedule-buy/plans/{plan_id}/batches`
- Auth: HTTP bearer

One page of a plan's batch history, oldest batch first. SPENDS NOTHING. 404 for a plan that is not the organisation's.

## Path parameters

- `plan_id` integer, required: Schedule Buy plan id - from GET /mailboxes/schedule-buy/plans

## Query parameters

- `page` integer: 1-based page index.
- `limit` integer: Rows per page.
- `return_total` boolean: Include a real COUNT over the matching set.
- `agFilterModel` string, nullable: AG Grid filterModel JSON.
- `agSortModel` string, nullable: AG Grid sortModel JSON.

## Headers

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

## Response `200`

Successful Response

- ApiResponseMailboxDomainPayload
  - `data` MailboxDomainPayload, required: An open envelope for one provider/deliverability result. Open on purpose. These payloads are provider state and advisory reads whose contents grow with the product, and a dropped field reads as "nothing to report" rather than "we did not tell you". Every value passes through ``scrub_vendor_names`` on the way in.
  - `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)