## Get a price type

`GET /v1/catalog-price-types/:id`

Returns a single price type by identifier with all its fields.

## Parameters

| Parameter | Type | Req. | Description |
|----------|-----|:-----:|---------|
| `id` (path) | number | yes | Price type ID |

## Examples

### curl — personal key

```bash
curl "https://vibecode.bitrix24.com/v1/catalog-price-types/1" \
  -H "X-Api-Key: YOUR_API_KEY"
```

### curl — OAuth application

```bash
curl "https://vibecode.bitrix24.com/v1/catalog-price-types/1" \
  -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/catalog-price-types/1', {
  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/catalog-price-types/1', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

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

## Response fields

`data` is the price type object. The full field list — [Price type fields](/docs/entities/catalog-price-types/fields).

## Response example

```json
{
  "success": true,
  "data": {
    "base": "Y",
    "createdBy": 1,
    "dateCreate": "2020-04-22T05:37:42.000Z",
    "id": 1,
    "modifiedBy": 1,
    "name": "BASE",
    "sort": 100,
    "timestampX": "2024-10-22T04:31:37.000Z",
    "xmlId": "BASE"
  }
}
```

## Error response example

404 — the account has no price type with that number:

```json
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "priceType does not exist."
  }
}
```

## Errors

| HTTP | Code | Description |
|------|-----|---------|
| 404 | `ENTITY_NOT_FOUND` | The portal has no price type with that `id`. The message echoes Bitrix24's own words verbatim. Type numbers depend on the portal — check the [list](./list.md) |
| 422 | `BITRIX_ERROR` | Bitrix24 refused to read the price type: the key owner has no portal administrator rights |
| 403 | `SCOPE_DENIED` | The API key does not have the `catalog` scope |
| 401 | `MISSING_API_KEY` | The `X-Api-Key` header is missing |
| 429 | `RATE_LIMITED` | Rate limit exceeded: 300 requests per minute per portal, all API keys of the portal share one limit. The exact value arrives in the `x-ratelimit-limit` header (the cap is divided across replicas). Retry after the delay in the `Retry-After` header |

The full list of common API errors — [Errors](/docs/errors).

## Known specifics

**A type number does not carry over between accounts.** The same `id` on another account means a different price type, or does not exist at all. An integration working with several accounts must fetch the list on each of them.

**The method requires administrator rights.** The `catalog` scope is not enough: Bitrix24 returns a price type only to a key whose owner has the Bitrix24 account administrator role. Otherwise the API returns `422 BITRIX_ERROR` with a Bitrix24 message about insufficient rights.

## See also

- [List price types](/docs/entities/catalog-price-types/list)
- [Price type fields](/docs/entities/catalog-price-types/fields)
- [Catalog prices](/docs/entities/catalog-prices)
- [API reference](/docs/api-reference)