# Get deal

Read a deal by ID. Returns item: null when no visible record matches.

POST https://api.brigg.app/v1/operations/customers.GetDeal

## Access & visibility

Allow `customers.GetDeal` on your API key. Resource read permissions: `core:Deal`.

**Workspace access by default.** Private member data requires [approved member delegation](https://developer.brigg.app/authentication#member-delegation) through `Brigg-Act-As`; the key supplies permissions while private ownership and project boundaries remain enforced.

[Set up authentication](https://developer.brigg.app/authentication) · [Choose permissions](https://developer.brigg.app/permissions)

## Request fields

Send a JSON object with the following fields. Required fields must be included; omit optional fields you do not need.
| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string | Yes | ID of a visible `core:Deal` record. Find it with [customers.ListDeals](https://developer.brigg.app/reference/customers/ListDeals). Use the record's top-level `id`, not a business field or account ID. |

## Response

Returns **200 OK** with a JSON body.

`item: null` means there is no matching record visible to this caller. It does not reveal whether an inaccessible record exists.

Record metadata sits outside `data`. Timestamps `created_at` and `updated_at` are Unix milliseconds. Optional business fields may be absent; absence does not mean false or zero. A field accepts null only when its type includes null.

The public schema lists accepted stage IDs. Labels are presentation text; use the stable stage ID in calls.
| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `item` | [DealRecord](#dealrecord-response-item) or null | Yes | null when no such record |

### DealRecord · response.item

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string | Yes | Stable core:Deal record ID. Keep this top-level value when reading or referring to this record. Available actions are linked under Next steps; an ID does not imply the resource can be edited. |
| `created_at` | number | Yes | Time the record was created, in Unix milliseconds. |
| `updated_at` | number | Yes | Time the record most recently changed, in Unix milliseconds. Use with overlapping windows for incremental reads. |
| `created_by` | string or null | Yes | Account that originally created the record, or null for a workspace/system-originated record. This is provenance, not its current owner or a Person record ID. |
| `private` | boolean | Yes | True for a member-owned private record. An API key needs approved delegation to that owner; false alone does not bypass resource grants or other access rules. |
| `data` | [Deal](#deal-response-item-data) | Yes | The record's fields. |

### Deal · response.item.data

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `title` | string | Yes | Name of the sales opportunity. |
| `stage` | string | Yes | A stage id from the org's own sales pipeline, in funnel order: lead = Lead, qualified = Qualified, proposal = Proposal, negotiation = Negotiation, won = Won (won), lost = Lost (lost). The list is the org's to change — the pipeline is the `core:SalesPipeline` entry (edit its `stages` to add, rename, reorder or re-weight a stage; the ids here follow). Allowed: `"lead"`, `"qualified"`, `"proposal"`, `"negotiation"`, `"won"`, `"lost"`. |
| `amount_ore` | integer | No | Value of the opportunity in Norwegian øre. 1000000 is NOK 10,000. Deals are NOK-only; do not supply another currency. |
| `product_lines` | array of [object](#response-item-data-product-lines) | No | Products or services proposed in this deal, with quantities, prices and billing frequency. |
| `company_ref` | string | No | ID of a `core:Company` record. Find it with [customers.ListCompanies](https://developer.brigg.app/reference/customers/ListCompanies) and use the top-level `id`. This is not an account ID or a display name. |
| `contact_ref` | string | No | ID of a `core:Person` record. Find it with [customers.ListPeople](https://developer.brigg.app/reference/customers/ListPeople) and use the top-level `id`. This is not an account ID or a display name. |
| `owner_ref` | string | No | ID of a `core:Person` record. Find it with [customers.ListPeople](https://developer.brigg.app/reference/customers/ListPeople) and use the top-level `id`. This is not an account ID or a display name. |
| `expected_close_date` | string | No | Expected date the opportunity will be won or lost, in YYYY-MM-DD format. |
| `description` | string | No | Business context for the sales opportunity. |
| `lost_reason` | string | No | Reason recorded when the opportunity is lost. |
| `tags` | array of string | No | Stable tag keys, not labels. Use [List tag vocabularies](https://developer.brigg.app/reference/customers/ListTagVocabularies) to find the vocabulary for this resource type and field, then [List tags](https://developer.brigg.app/reference/customers/ListTags) for its key/label pairs. |

### response.item.data.product_lines[]

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `product_ref` | string | No | Product record ID. |
| `name` | string | Yes | Display name. |
| `description` | string | No | Descriptive text. |
| `quantity` | number | No | Number of units. May be fractional when the product allows it. Minimum: 0. |
| `unit` | string | No | Unit used for the quantity, such as hours or items. |
| `unit_price_ore` | integer | No | Price per unit in Norwegian øre; 100000 is NOK 1,000. Product lines use NOK only. |
| `agreed_at` | number | No | Time the commercial terms were agreed, in Unix milliseconds. |
| `agreed_deal_ref` | string | No | Deal record ID. |
| `revenue_type` | string | No | Whether this amount is charged once or repeats monthly, quarterly or annually. Allowed: `"one_time"`, `"monthly"`, `"quarterly"`, `"annual"`. |
| `start_date` | string | No | ISO date (YYYY-MM-DD) |
| `end_date` | string | No | ISO date (YYYY-MM-DD) |

## Errors & retries

This operation reads data. It needs no idempotency key and can be retried after a transient failure.

For rate limits, follow the server’s retry guidance and back off. See [HTTP errors](https://developer.brigg.app/http#errors) and [safe retries and limits](https://developer.brigg.app/reliability).

| HTTP status | Code | What to do |
| --- | --- | --- |
| 400 | `invalid_json` | Send a JSON object with Content-Type: application/json. |
| 400 | `invalid_input` | Check the request fields and types. |
| 401 | `invalid_key` | The workspace API key is missing, invalid or revoked. |
| 403 | `forbidden` | Check the key’s operation and resource grants. If Brigg-Act-As is supplied, the key must be authorized to delegate to that member. |
| 404 | `not_found` | The requested operation or resource is not available to this credential. |
| 429 | `rate_limited` | Wait for Retry-After before retrying. |

## Next steps

- [List deals](https://developer.brigg.app/reference/customers/ListDeals)
- [Create deal](https://developer.brigg.app/reference/customers/CreateDeal)
- [Upsert deal](https://developer.brigg.app/reference/customers/UpsertDeal)
- [Update deal](https://developer.brigg.app/reference/customers/UpdateDeal)
- [Delete deal](https://developer.brigg.app/reference/customers/DeleteDeal)

[Download OpenAPI](https://developer.brigg.app/openapi.json) · [Versioning & retirement](https://developer.brigg.app/versioning)

## Examples

### Example request

Fictional values. Replace IDs and business details with values from your workspace.
#### cURL


```sh
curl 'https://api.brigg.app/v1/operations/customers.GetDeal' \
  -H "Authorization: Bearer $BRIGG_API_KEY" \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "id": "e_deal_example"
}'
```

#### TypeScript


```typescript
const response = await fetch("https://api.brigg.app/v1/operations/customers.GetDeal", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.BRIGG_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "id": "e_deal_example"
  }),
});
const result = await response.json();
if (!response.ok) throw new Error(`${response.status}: ${result.error} — ${result.message}`);
console.log(result);
```

#### Python


```python
import json
import os
from urllib.request import Request, urlopen
from urllib.error import HTTPError

payload = {
  "id": "e_deal_example"
}
request = Request(
    "https://api.brigg.app/v1/operations/customers.GetDeal",
    data=json.dumps(payload).encode("utf-8"),
    headers={
        "Authorization": f"Bearer {os.environ['BRIGG_API_KEY']}",
        "Content-Type": "application/json",
    },
    method="POST",
)
try:
    with urlopen(request) as response:
        print(json.load(response))
except HTTPError as error:
    print(error.code, json.load(error))
    raise
```

#### Response example


```json
{
  "item": {
    "id": "e_deal_example",
    "created_at": 1794301200000,
    "updated_at": 1794301200000,
    "created_by": "a_example",
    "private": false,
    "data": {
      "title": "Customer onboarding project",
      "stage": "proposal",
      "amount_ore": 1000000,
      "company_ref": "e_company_example",
      "contact_ref": "e_person_example",
      "expected_close_date": "2026-11-30"
    }
  }
}
```

### No visible record

A missing or inaccessible record returns item: null. Do not treat this as proof that a record exists for another member.
#### cURL


```sh
curl 'https://api.brigg.app/v1/operations/customers.GetDeal' \
  -H "Authorization: Bearer $BRIGG_API_KEY" \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "id": "e_deal_example"
}'
```

#### TypeScript


```typescript
const response = await fetch("https://api.brigg.app/v1/operations/customers.GetDeal", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.BRIGG_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "id": "e_deal_example"
  }),
});
const result = await response.json();
if (!response.ok) throw new Error(`${response.status}: ${result.error} — ${result.message}`);
console.log(result);
```

#### Python


```python
import json
import os
from urllib.request import Request, urlopen
from urllib.error import HTTPError

payload = {
  "id": "e_deal_example"
}
request = Request(
    "https://api.brigg.app/v1/operations/customers.GetDeal",
    data=json.dumps(payload).encode("utf-8"),
    headers={
        "Authorization": f"Bearer {os.environ['BRIGG_API_KEY']}",
        "Content-Type": "application/json",
    },
    method="POST",
)
try:
    with urlopen(request) as response:
        print(json.load(response))
except HTTPError as error:
    print(error.code, json.load(error))
    raise
```

#### Response example


```json
{
  "item": null
}
```

## JSON schemas


```json-schema-request
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "ID of a visible `core:Deal` record. Find it with [customers.ListDeals](https://developer.brigg.app/reference/customers/ListDeals). Use the record's top-level `id`, not a business field or account ID."
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": false,
  "examples": [
    {
      "id": "e_deal_example"
    }
  ]
}
```


```json-schema-response
{
  "type": "object",
  "properties": {
    "item": {
      "type": [
        "object",
        "null"
      ],
      "properties": {
        "id": {
          "type": "string",
          "description": "Stable core:Deal record ID. Keep this top-level value when reading or referring to this record. Available actions are linked under Next steps; an ID does not imply the resource can be edited."
        },
        "created_at": {
          "type": "number",
          "description": "Time the record was created, in Unix milliseconds."
        },
        "updated_at": {
          "type": "number",
          "description": "Time the record most recently changed, in Unix milliseconds. Use with overlapping windows for incremental reads."
        },
        "created_by": {
          "type": [
            "string",
            "null"
          ],
          "description": "Account that originally created the record, or null for a workspace/system-originated record. This is provenance, not its current owner or a Person record ID."
        },
        "private": {
          "type": "boolean",
          "description": "True for a member-owned private record. An API key needs approved delegation to that owner; false alone does not bypass resource grants or other access rules."
        },
        "data": {
          "type": "object",
          "properties": {
            "title": {
              "type": "string",
              "description": "Name of the sales opportunity."
            },
            "stage": {
              "type": "string",
              "enum": [
                "lead",
                "qualified",
                "proposal",
                "negotiation",
                "won",
                "lost"
              ],
              "description": "A stage id from the org's own sales pipeline, in funnel order: lead = Lead, qualified = Qualified, proposal = Proposal, negotiation = Negotiation, won = Won (won), lost = Lost (lost). The list is the org's to change — the pipeline is the `core:SalesPipeline` entry (edit its `stages` to add, rename, reorder or re-weight a stage; the ids here follow)."
            },
            "amount_ore": {
              "type": "integer",
              "description": "Value of the opportunity in Norwegian øre. 1000000 is NOK 10,000. Deals are NOK-only; do not supply another currency."
            },
            "product_lines": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "product_ref": {
                    "type": "string",
                    "description": "Product record ID."
                  },
                  "name": {
                    "type": "string",
                    "description": "Display name."
                  },
                  "description": {
                    "type": "string",
                    "description": "Descriptive text."
                  },
                  "quantity": {
                    "type": "number",
                    "minimum": 0,
                    "description": "Number of units. May be fractional when the product allows it."
                  },
                  "unit": {
                    "type": "string",
                    "description": "Unit used for the quantity, such as hours or items."
                  },
                  "unit_price_ore": {
                    "type": "integer",
                    "description": "Price per unit in Norwegian øre; 100000 is NOK 1,000. Product lines use NOK only."
                  },
                  "agreed_at": {
                    "type": "number",
                    "description": "Time the commercial terms were agreed, in Unix milliseconds."
                  },
                  "agreed_deal_ref": {
                    "type": "string",
                    "description": "Deal record ID."
                  },
                  "revenue_type": {
                    "type": "string",
                    "enum": [
                      "one_time",
                      "monthly",
                      "quarterly",
                      "annual"
                    ],
                    "description": "Whether this amount is charged once or repeats monthly, quarterly or annually."
                  },
                  "start_date": {
                    "type": "string",
                    "description": "ISO date (YYYY-MM-DD)"
                  },
                  "end_date": {
                    "type": "string",
                    "description": "ISO date (YYYY-MM-DD)"
                  }
                },
                "required": [
                  "name"
                ],
                "additionalProperties": false
              },
              "description": "Products or services proposed in this deal, with quantities, prices and billing frequency."
            },
            "company_ref": {
              "type": "string",
              "description": "ID of a `core:Company` record. Find it with [customers.ListCompanies](https://developer.brigg.app/reference/customers/ListCompanies) and use the top-level `id`. This is not an account ID or a display name."
            },
            "contact_ref": {
              "type": "string",
              "description": "ID of a `core:Person` record. Find it with [customers.ListPeople](https://developer.brigg.app/reference/customers/ListPeople) and use the top-level `id`. This is not an account ID or a display name."
            },
            "owner_ref": {
              "type": "string",
              "description": "ID of a `core:Person` record. Find it with [customers.ListPeople](https://developer.brigg.app/reference/customers/ListPeople) and use the top-level `id`. This is not an account ID or a display name."
            },
            "expected_close_date": {
              "type": "string",
              "description": "Expected date the opportunity will be won or lost, in YYYY-MM-DD format."
            },
            "description": {
              "type": "string",
              "description": "Business context for the sales opportunity."
            },
            "lost_reason": {
              "type": "string",
              "description": "Reason recorded when the opportunity is lost."
            },
            "tags": {
              "type": "array",
              "items": {
                "type": "string"
              },
              "description": "Stable tag keys, not labels. Use [List tag vocabularies](https://developer.brigg.app/reference/customers/ListTagVocabularies) to find the vocabulary for this resource type and field, then [List tags](https://developer.brigg.app/reference/customers/ListTags) for its key/label pairs."
            }
          },
          "required": [
            "title",
            "stage"
          ],
          "additionalProperties": false,
          "description": "The record's fields.",
          "title": "Deal"
        }
      },
      "required": [
        "id",
        "created_at",
        "updated_at",
        "created_by",
        "private",
        "data"
      ],
      "additionalProperties": false,
      "description": "null when no such record",
      "title": "DealRecord"
    }
  },
  "required": [
    "item"
  ],
  "additionalProperties": false,
  "examples": [
    {
      "item": {
        "id": "e_deal_example",
        "created_at": 1794301200000,
        "updated_at": 1794301200000,
        "created_by": "a_example",
        "private": false,
        "data": {
          "title": "Customer onboarding project",
          "stage": "proposal",
          "amount_ore": 1000000,
          "company_ref": "e_company_example",
          "contact_ref": "e_person_example",
          "expected_close_date": "2026-11-30"
        }
      }
    }
  ]
}
```