# List deals

`GET https://api.versionseven.ai/v1/crm/deals`

Deals in your organization, newest first, each with a summary of its lead. Filter by `stage_id`, `owner_id` or `lead_id`, and page with `limit` and `offset`.

- Required scope: `crm:read`

## Request

**cURL**

```bash
curl "https://api.versionseven.ai/v1/crm/deals" \
  -H "Authorization: Bearer $VICTORIA_API_KEY"
```

**Node.js**

```javascript
const response = await fetch("https://api.versionseven.ai/v1/crm/deals", {
  headers: {
    Authorization: `Bearer ${process.env.VICTORIA_API_KEY}`,
  },
});

const data = await response.json();
```

**Python**

```python
import os

import requests

response = requests.get(
    "https://api.versionseven.ai/v1/crm/deals",
    headers={
        "Authorization": f"Bearer {os.environ['VICTORIA_API_KEY']}",
    },
)
data = response.json()
```

## Headers

- `Authorization` (string, required): `Bearer` followed by a space and your API key, for example `Bearer vk_…`.

## Query parameters

- `stage_id` (string · uuid or null, optional): Filter by stage ID
- `owner_id` (string · uuid or null, optional): Filter by owner ID
- `lead_id` (string · uuid or null, optional): Filter by lead ID
- `limit` (integer, optional, ≥ 1, ≤ 100, default `50`): Maximum number of deals to return
- `offset` (integer, optional, ≥ 0, default `0`): Number of deals to skip

## Response

### `200`

```json
{
  "total": 1,
  "limit": 1,
  "offset": 1,
  "has_more": true,
  "message": "string",
  "deals": [
    {
      "name": "Acme Corp - Enterprise License",
      "actual_close_date": "2026-01-14T19:30:00+00:00",
      "created_at": "2024-01-15T10:30:00+00:00",
      "custom_fields": {},
      "expected_close_date": "2024-03-31T00:00:00+00:00",
      "id": "e3f4a5b6-c7d8-9012-ef01-345678901234",
      "lead": {},
      "lead_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "metadata": {},
      "notes": "Initial meeting scheduled for next week",
      "owner_id": "f4a5b6c7-d8e9-0123-f012-456789012345",
      "probability": 75,
      "stage_id": "d2e3f4a5-b6c7-8901-def0-234567890123",
      "updated_at": "2024-01-20T14:45:00+00:00",
      "value": 50000
    }
  ],
  "count": 1,
  "success": true
}
```

- `total` (integer, required): Total rows matching the query, across all pages
- `limit` (integer, required): Page size that was applied
- `offset` (integer, required): Rows skipped before this page
- `has_more` (boolean, required): Whether a further page exists
- `message` (string, required)
- `deals` (array of objects, required): List of deals
  - `name` (string, required, example `"Acme Corp - Enterprise License"`): Deal name/title
  - `actual_close_date` (string · date-time or null, optional): Actual close date (set when deal is won/lost)
  - `created_at` (string · date-time or null, optional, example `"2024-01-15T10:30:00+00:00"`): When the deal was created
  - `custom_fields` (object or null, optional): Custom fields as key-value pairs
  - `expected_close_date` (string · date-time or null, optional, example `"2024-03-31T00:00:00+00:00"`): Expected close date
  - `id` (string or null, optional, example `"e3f4a5b6-c7d8-9012-ef01-345678901234"`): Deal ID
  - `lead` (object or null, optional): Associated lead data
  - `lead_id` (string or null, optional, example `"a1b2c3d4-e5f6-7890-abcd-ef1234567890"`): Associated lead ID
  - `metadata` (object or null, optional): Additional metadata
  - `notes` (string or null, optional, example `"Initial meeting scheduled for next week"`): Deal notes
  - `owner_id` (string or null, optional, example `"f4a5b6c7-d8e9-0123-f012-456789012345"`): ID of the deal owner (user)
  - `probability` (integer or null, optional, example `75`): Win probability percentage (0-100)
  - `stage_id` (string or null, optional, example `"d2e3f4a5-b6c7-8901-def0-234567890123"`): Current stage ID
  - `updated_at` (string · date-time or null, optional, example `"2024-01-20T14:45:00+00:00"`): When the deal was last updated
  - `value` (number or null, optional, example `50000`): Deal value in dollars
- `count` (integer, required): Deals in this page
- `success` (boolean, optional, default `true`)

## Errors

Errors share one JSON body: `success`, `error`, `message`, optional `details`, and `request_id`. For example:

```json
{
  "success": false,
  "error": "UNAUTHORIZED",
  "message": "Invalid or inactive API key",
  "request_id": "734d11a1-54d4-414c-9e8d-4e1ada977db4"
}
```

| Status | Code | Meaning |
| --- | --- | --- |
| 400 | `VALIDATION_ERROR` | The request didn't match the endpoint's schema: a missing or malformed field, a bad query parameter, or a value out of range. `details.errors` lists each failing field with its `field`, `message` and `type`. |
| 401 | `UNAUTHORIZED` | The `Authorization` header is missing or malformed, or the API key is unknown or has been deactivated. |
| 401 | `API_KEY_EXPIRED` | The API key is past its expiry date. Create a new key in the Victoria AI app. |
| 403 | `INSUFFICIENT_SCOPE` | The API key doesn't have the scope this endpoint requires, such as `leads:write`. |
| 403 | `ORGANIZATION_DEACTIVATED` | The organization that owns this API key has been deactivated. |
| 429 | `RATE_LIMITED` | Too many requests for this API key: more than 100 a minute to one endpoint, or 600 a minute in total. Retry after the number of seconds in the `Retry-After` header. See [Rate limits](https://docs.versionseven.ai/guides/rate-limits). |
| 500 | `INTERNAL_ERROR` | Something failed on our side. The response never includes internal details; quote its `request_id` when you contact support. |
| 503 | `UPSTREAM_TIMEOUT` | A service the API depends on timed out. The request is safe to retry. |
| 503 | `AUTH_UNAVAILABLE` | The API key couldn't be checked because the authentication service was unavailable. The request is safe to retry. |

## Response headers

| Header | Description |
| --- | --- |
| `X-Request-ID` | Correlation ID for the request, also returned as `request_id` in error bodies. Send your own `X-Request-ID`, up to 128 letters, digits, `.`, `_`, `:` or `-`, and it's used instead. |
| `RateLimit-Limit` | Requests allowed to this endpoint per minute. |
| `RateLimit-Remaining` | Requests you can still send to this endpoint right now. |
| `RateLimit-Reset` | Seconds until the endpoint's full limit is available again. |
| `Retry-After` | On a `429`: seconds to wait before retrying. |