# Retrieve a pipeline

`GET https://api.versionseven.ai/v1/crm/pipelines/{pipeline_id}`

A pipeline with its active stages, in display order.

- Required scope: `crm:read`

## Request

**cURL**

```bash
curl "https://api.versionseven.ai/v1/crm/pipelines/a5ad8316-bbdf-4e40-9e27-da8c81593927" \
  -H "Authorization: Bearer $VICTORIA_API_KEY"
```

**Node.js**

```javascript
const response = await fetch("https://api.versionseven.ai/v1/crm/pipelines/a5ad8316-bbdf-4e40-9e27-da8c81593927", {
  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/pipelines/a5ad8316-bbdf-4e40-9e27-da8c81593927",
    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_…`.

## Path parameters

- `pipeline_id` (string · uuid, required): ID of the pipeline.

## Response

### `200`

```json
{
  "message": "string",
  "pipeline": {
    "name": "Enterprise Sales",
    "created_at": "2024-01-15T10:30:00+00:00",
    "id": "c1d2e3f4-a5b6-7890-cdef-123456789012",
    "is_active": true,
    "is_default": false,
    "updated_at": "2024-01-20T14:45:00+00:00"
  },
  "stages": [
    {
      "pipeline_id": "c1d2e3f4-a5b6-7890-cdef-123456789012",
      "name": "Qualified",
      "display_order": 2,
      "created_at": "2024-01-15T10:30:00+00:00",
      "id": "d2e3f4a5-b6c7-8901-def0-234567890123",
      "is_active": true,
      "updated_at": "2024-01-20T14:45:00+00:00"
    }
  ],
  "success": true
}
```

- `message` (string, required)
- `pipeline` (object, required): Pipeline data
  - `name` (string, required, example `"Enterprise Sales"`): Pipeline name
  - `created_at` (string · date-time or null, optional, example `"2024-01-15T10:30:00+00:00"`): When the pipeline was created
  - `id` (string or null, optional, example `"c1d2e3f4-a5b6-7890-cdef-123456789012"`): Pipeline ID
  - `is_active` (boolean, optional, default `true`): Whether this pipeline is active
  - `is_default` (boolean, optional, default `false`): Whether this is the default pipeline
  - `updated_at` (string · date-time or null, optional, example `"2024-01-20T14:45:00+00:00"`): When the pipeline was last updated
- `stages` (array of objects, optional): Stages in this pipeline
  - `pipeline_id` (string, required, example `"c1d2e3f4-a5b6-7890-cdef-123456789012"`): ID of the parent pipeline
  - `name` (string, required, example `"Qualified"`): Stage name
  - `display_order` (integer, required, example `2`): Order in which the stage appears (lower = earlier)
  - `created_at` (string · date-time or null, optional, example `"2024-01-15T10:30:00+00:00"`): When the stage was created
  - `id` (string or null, optional, example `"d2e3f4a5-b6c7-8901-def0-234567890123"`): Stage ID
  - `is_active` (boolean, optional, default `true`): Whether this stage is active
  - `updated_at` (string · date-time or null, optional, example `"2024-01-20T14:45:00+00:00"`): When the stage was last updated
- `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 |
| --- | --- | --- |
| 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. |
| 404 | `PIPELINE_NOT_FOUND` | No pipeline with this ID exists in your organization. |
| 404 | `NOT_FOUND` | No endpoint matches the path. A resource ID in the path that isn't a valid UUID also answers `NOT_FOUND`. |
| 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. |