## Get order status

`GET /v1/order-statuses/:id`

Returns a single order or delivery status by character code.

## Parameters

| Parameter | Type | Req. | Description |
|----------|-----|:-----:|---------|
| `id` (path) | string | yes | Status character code (for example, `N`, `IP`, `DT`) |

## Examples

### curl — personal key

```bash
curl "https://vibecode.bitrix24.com/v1/order-statuses/D" \
  -H "X-Api-Key: YOUR_API_KEY"
```

### curl — OAuth application

```bash
curl "https://vibecode.bitrix24.com/v1/order-statuses/D" \
  -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/order-statuses/D', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data } = await res.json()
console.log('Status:', data.id, '— type:', data.type)
```

### JavaScript — OAuth application

```javascript
const res = await fetch('https://vibecode.bitrix24.com/v1/order-statuses/D', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

const { success, data } = await res.json()
```

## Response fields

| Field | Type | Description |
|------|-----|---------|
| `id` | string | Status character code |
| `type` | string | Status type: `O` — order, `D` — delivery |
| `sort` | number \| null | Sort order |
| `notify` | boolean | Whether to send a notification to the customer |
| `color` | string \| null | HEX color code or `null` |
| `xmlId` | string \| null | External identifier or `null` |

## Response example

```json
{
  "success": true,
  "data": {
    "id": "D",
    "type": "O",
    "sort": 140,
    "notify": true,
    "color": "#FFBEBD",
    "xmlId": null
  }
}
```

## Error response example

422 — status not found:

```json
{
  "success": false,
  "error": {
    "code": "BITRIX_ERROR",
    "message": "status is not exists"
  }
}
```

## Errors

| HTTP | Code | Description |
|------|-----|---------|
| 422 | `BITRIX_ERROR` | A status with this `id` was not found |
| 403 | `SCOPE_DENIED` | The API key does not have the `sale` scope |
| 401 | `TOKEN_MISSING` | The API key has no configured tokens |

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

## See also

- [Update status](./update.md)
- [Delete status](./delete.md)
- [List statuses](./list.md)
- [Status fields](./fields.md)
- [Orders in this status](../orders/list.md)
- [Limits and optimization](/docs/optimization)