## Get a pipeline

`GET /v1/deal-categories/:id`

Returns a sales pipeline by ID.

## Path parameters

| Parameter | Type | Description |
|----------|-----|---------|
| `id` | number | Pipeline ID. List — `GET /v1/deal-categories` |

The main pipeline with id `0` is not available via this endpoint — use `/v1/categories/2/0` for it.

## Examples

### curl — personal key

```bash
curl "https://vibecode.bitrix24.com/v1/deal-categories/3" \
  -H "X-Api-Key: YOUR_API_KEY"
```

### curl — OAuth application

```bash
curl "https://vibecode.bitrix24.com/v1/deal-categories/3" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"
```

### JavaScript — personal key

```javascript
const res = await fetch('https://vibecode.bitrix24.com/v1/deal-categories/3', {
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})
const { success, data } = await res.json()
```

### JavaScript — OAuth application

```javascript
const res = await fetch('https://vibecode.bitrix24.com/v1/deal-categories/3', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})
const { success, data } = await res.json()
```

## Response fields

| Field | Type | Description |
|------|-----|---------|
| `id` | number | Pipeline ID |
| `name` | string | Name |
| `sort` | number | Sort |
| `isLocked` | boolean | Whether the pipeline is locked — unavailable on the current plan |
| `createdAt` | datetime | Creation date |

## Response example

```json
{
  "success": true,
  "data": {
    "id": 3,
    "name": "Corporate sales",
    "sort": 200,
    "isLocked": false,
    "createdAt": "2025-06-01T14:00:00.000Z"
  }
}
```


## Error response example

```json
{
  "success": false,
  "error": { "code": "ENTITY_NOT_FOUND", "message": "Not found" }
}
```

## Errors

| HTTP | Code | Description |
|------|-----|---------|
| 404 | `ENTITY_NOT_FOUND` | Pipeline not found |
| 403 | `SCOPE_DENIED` | The API key lacks the `crm` scope |
| 401 | `TOKEN_MISSING` | No API key provided |

Full list of errors — [Errors](/docs/errors).

## See also

- [List pipelines](/docs/entities/deal-categories/list) — all pipelines
- [Update a pipeline](/docs/entities/deal-categories/update) — changing the name
- [Sales pipelines](/docs/entities/deal-categories) — entity overview