---
title: "Get Deal Detail"
method: GET
path: "/deals/{deal_id}/detail"
tags: ["Deals"]
---

# Get Deal Detail

`GET /deals/{deal_id}/detail`

## Request

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

The full deal record the detail page reads.

## Path parameters

- `deal_id` string, required: Deal id.

## Query parameters

- `include_revision` boolean: Include the optimistic-concurrency revision. Null in the response means this org has no revision tracking, so a save is unconditional - it does NOT mean revision 1.

## Headers

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

## Response `200`

Successful Response

- ApiResponseDealDetail
  - `data` DealDetail, required: One deal, with the related data the detail page reads. `revision` is the optimistic-concurrency token. It is `None` when the org has no canonical revision tracking provisioned - the app degrades rather than 503ing a read - and a null there means an unconditional save, NOT revision 1. Do not default it.
    - `id` string, nullable
    - `name` string, nullable
    - `description` string, nullable
    - `revision` integer, nullable: Optimistic-concurrency token. None means this org has no revision tracking, so a save is unconditional - it does NOT mean 1.
    - `amount` number, nullable
    - `currency` string, nullable
    - `stage` string, nullable
    - `status` string, nullable
    - `pipeline_id` string, nullable
    - `stage_id` string, nullable
    - `owner_id` string, nullable
    - `company_id` string, nullable
    - `close_date` string, date-time, nullable
    - `created_at` string, date-time, nullable
    - `updated_at` string, date-time, nullable
  - `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)