## Get a sticker pack

`GET /v1/chats/stickers/packs/:packId`

Returns a sticker pack with all its stickers: a built-in pack or any user pack in the Bitrix24 account, not only your own. This is how Bitrix24 shows the pack of a sticker that arrived in a message.

## Parameters

| Parameter | Type | Required | Description |
|----------|-----|:-----:|----------|
| `packId` (path) | number | yes | Pack ID — `data.packs[].id` from the [list of packs](/docs/chats/stickers/packs) or the `packId` of a sticker from a message (the `data.stickers` field of the [first page of messages](/docs/chats/messages/initial)) |
| `packType` (query) | string | yes | `vendor` — a built-in pack, `custom` — a user pack |

## Examples

### curl — personal key

```bash
curl "https://vibecode.bitrix24.com/v1/chats/stickers/packs/14?packType=vendor" \
  -H "X-Api-Key: YOUR_API_KEY"
```

### curl — OAuth application

```bash
curl "https://vibecode.bitrix24.com/v1/chats/stickers/packs/14?packType=vendor" \
  -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/chats/stickers/packs/14?packType=vendor', {
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})

const { data } = await res.json()
console.log(data.pack.name, '— stickers:', data.stickers.length)
```

### JavaScript — OAuth application

```javascript
const res = await fetch('https://vibecode.bitrix24.com/v1/chats/stickers/packs/14?packType=vendor', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

const { data } = await res.json()
console.log(data.pack.name, '— stickers:', data.stickers.length)
```

## Response fields

| Field | Type | Description |
|------|-----|---------|
| `success` | boolean | Always `true` on success |
| `data.pack` | object | The pack |
| `data.pack.id` | number | Pack ID |
| `data.pack.name` | string | Pack name |
| `data.pack.type` | string | Pack type: `vendor` or `custom` |
| `data.pack.authorId` | number \| null | ID of the author of a user pack; `null` for a built-in pack |
| `data.pack.isAdded` | boolean | The pack is in the user's list |
| `data.stickers` | array | Stickers of the pack |
| `data.stickers[].id` | number | Sticker ID |
| `data.stickers[].packId` | number | Pack ID |
| `data.stickers[].packType` | string | Pack type: `vendor` or `custom` |
| `data.stickers[].uri` | string | Path to the image in the Bitrix24 account — relative, without the domain |
| `data.stickers[].type` | string | Sticker type: `image` |
| `data.stickers[].width` | number | Image width in pixels |
| `data.stickers[].height` | number | Image height in pixels |
| `data.stickers[].sort` | number | Sticker order in the pack |

## Response example

Two stickers of the pack are shown:

```json
{
  "success": true,
  "data": {
    "stickers": [
      { "id": 1, "uri": "/bitrix/images/im/stickers/aiHelp/1.png?v1", "type": "image", "width": 512, "height": 512, "packId": 14, "packType": "vendor", "sort": 1 },
      { "id": 2, "uri": "/bitrix/images/im/stickers/aiHelp/2.png?v1", "type": "image", "width": 512, "height": 512, "packId": 14, "packType": "vendor", "sort": 2 }
    ],
    "pack": { "id": 14, "name": "AI Help", "type": "vendor", "authorId": null, "isAdded": true }
  }
}
```

## Error response example

422 — there is no pack with this `id` and `packType`:

```json
{
  "success": false,
  "error": {
    "code": "BITRIX_ERROR",
    "message": "PACK_NOT_AVAILABLE",
    "b24Code": "PACK_NOT_AVAILABLE"
  }
}
```

## Errors

| HTTP | Code | Description |
|------|-----|---------|
| 400 | `INVALID_PARAMS` | `packId` is not a positive integer, `packType` is missing or is not `vendor` / `custom`, another parameter was passed, or a parameter was repeated |
| 401 | `TOKEN_MISSING` | The key has no configured Bitrix24 tokens |
| 403 | `SCOPE_DENIED` | The key lacks the `im` scope |
| 404 | `ENTITY_NOT_FOUND` | Bitrix24 did not find the object; the portal code is in `error.b24Code` if supplied |
| 422 | `BITRIX_ERROR` | `error.b24Code`: `PACK_NOT_AVAILABLE` — the pack does not exist |
| 502 | `BITRIX_UNAVAILABLE` | Bitrix24 is unavailable or returned a server error |

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

## Known specifics

- A built-in pack and a user pack may have the same `id`, so `packType` is required.

## See also

- [List of packs](/docs/chats/stickers/packs)
- [Rename a pack](/docs/chats/stickers/pack-update)
- [Delete a pack](/docs/chats/stickers/pack-delete)
- [Add a pack](/docs/chats/stickers/link-create)