## Smart process type list

`GET /v1/smart-processes`

Returns the smart process types in your Bitrix24 account. Each type has an `entityTypeId` — use it to work with items via [/v1/items/:entityTypeId](/docs/entities/items).

## Parameters

| Parameter | Type | Default | Description |
|----------|-----|-----------|---------|
| `filter` | object | — | Filter by fields. Example: `?filter[isStagesEnabled]=true`. [Filtering syntax](/docs/filtering) |
| `select` | string | — | Field selection: `?select=id,title,entityTypeId` |
| `sort` | string | — | Sort by field: `?sort=title` (ascending), `?sort=-createdTime` (descending) |
| `limit` | number | — | Limit the number of records in the response |

The list of fields for `filter` and `select` — [Type fields](/docs/entities/smart-processes/fields).

For several filter conditions at once, use [Search types](/docs/entities/smart-processes/search) — a POST with a request body instead of a query string.

## Examples

### curl — personal key

```bash
curl "https://vibecode.bitrix24.com/v1/smart-processes" \
  -H "X-Api-Key: YOUR_API_KEY"
```

### curl — OAuth application

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

const { success, data } = await res.json()
for (const sp of data) {
  console.log(`${sp.title}: entityTypeId=${sp.entityTypeId}`)
}
```

### JavaScript — OAuth application

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

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

## Response fields

| Field | Type | Description |
|------|-----|---------|
| `data` | array | Array of smart process types. The fields of each type — see [Type fields](/docs/entities/smart-processes/fields) |

The list of items of any type from the `data` array opens in Bitrix24 by `entityTypeId`:

```
https://<portal>.bitrix24.com/crm/type/<entityTypeId>/list/category/0/
```

`0` — the main pipeline. `<portal>` — the Bitrix24 account domain. Access is restricted by the employee's permissions in Bitrix24.

## Response example

```json
{
  "success": true,
  "data": [
    {
      "id": 3,
      "entityTypeId": 174,
      "title": "Contracts",
      "code": null,
      "customSectionId": null,
      "isCategoriesEnabled": true,
      "isStagesEnabled": true,
      "isClientEnabled": true,
      "isLinkWithProductsEnabled": true,
      "isObserversEnabled": true,
      "isSourceEnabled": true,
      "isAutomationEnabled": true,
      "isBizProcEnabled": true,
      "isDocumentsEnabled": true,
      "isRecyclebinEnabled": true,
      "isSetOpenPermissions": true,
      "isUseInUserfieldEnabled": true,
      "createdBy": 1,
      "updatedBy": 1,
      "createdTime": "2021-07-20T16:04:10+00:00",
      "updatedTime": "2024-07-19T14:27:27+00:00"
    }
  ]
}
```

## Error response example

403 — no scope:

```json
{
  "success": false,
  "error": {
    "code": "SCOPE_DENIED",
    "message": "This endpoint requires 'crm' scope"
  }
}
```

## Errors

| HTTP | Code | Description |
|------|-----|---------|
| 401 | `MISSING_API_KEY` | The `X-Api-Key` header was not passed |
| 401 | `INVALID_API_KEY` | The key was not found or was revoked |
| 403 | `SCOPE_DENIED` | The API key does not have the `crm` scope |
| 401 | `TOKEN_MISSING` | The API key has no configured tokens |
| 422 | `BITRIX_ERROR` | An error from Bitrix24. The specific reason is in the `message` field |

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

## Known specifics

**`entityTypeId` — the key field.** Save it and pass it to `/v1/items/:entityTypeId` to work with items of this type.

**No pagination.** The response contains all smart process types in your Bitrix24 account in a single array.

## See also

- [Create a type](/docs/entities/smart-processes/create)
- [Get a type](/docs/entities/smart-processes/get)
- [Type fields](/docs/entities/smart-processes/fields)
- [Search types](/docs/entities/smart-processes/search)
- [Smart process items](/docs/entities/items)
- [Filtering syntax](/docs/filtering)
- [Limits and optimization](/docs/optimization)