---
title: "List Account Deals"
method: GET
path: "/accounts/{account_id}/deals"
tags: ["Deals"]
---

# List Account Deals

`GET /accounts/{account_id}/deals`

## Request

- Base URL: `https://be.graph8.com/api/v1`
- URL: `https://be.graph8.com/api/v1/accounts/{account_id}/deals`
- Auth: HTTP bearer

Deals on one account.

No per-record gate: a LIST is filtered by `deal_scope`, which the app
handler takes as a parameter and applies itself. Gating row by row here
would be both redundant and wrong - there is no single deal id to check.

## Path parameters

- `account_id` string, required: Account id.

## Headers

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

## Response `200`

Successful Response

- ApiResponseDealListResponse
  - `data` DealListResponse, required: A page of deals on one account.
    - `deals` DealSummary[]
      - `id` string, nullable
      - `name` string, nullable
      - `amount` number, nullable
      - `currency` string, nullable
      - `stage` string, nullable
      - `status` string, nullable
      - `pipeline_id` string, nullable
      - `owner_id` string, nullable
      - `close_date` string, date-time, nullable
      - `created_at` string, date-time, nullable
    - `total` integer
  - `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/89fc11143b70?raw)
