## Get a smart process type

`GET /v1/smart-processes/:entityTypeId`

Returns a smart process type by `entityTypeId`.

## Parameters

| Parameter | Type | Required | Description |
|----------|-----|:-----:|---------|
| `entityTypeId` (path) | number | **yes** | Entity type ID. List: `GET /v1/smart-processes` |

## Examples

### curl — personal key

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

### curl — OAuth application

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

const { success, data } = await res.json()
console.log('Type:', data.title, 'entityTypeId:', data.entityTypeId)
```

### JavaScript — OAuth application

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

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

## Response fields

| Field | Type | Description |
|------|-----|---------|
| `data` | object | Smart process type. Full field list — see [Type fields](/docs/entities/smart-processes/fields) |

## 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"
  }
}
```

> **The card returns more fields than the list and `/fields`.** In addition to the fields above, `GET /v1/smart-processes/:entityTypeId` returns `relations` (an object with `parent`/`child` arrays), `linkedUserFields` (a map) and `customSections` (an array) — this is a passthrough from Bitrix24 `crm.type.get` that is present neither in the list nor in `/fields`. `relations`/`linkedUserFields` are documented as create/update input fields. `customSections` appears only in the card response.
>
> **`id` ≠ the card key.** The response has an internal `id` (e.g. 3), but the card is addressed by `entityTypeId` (e.g. 174): `GET /v1/smart-processes/<entityTypeId>`. `GET /v1/smart-processes/<id>` returns `404 ENTITY_NOT_FOUND` — do not confuse the `id` field with the path key.

## Error response example

404 — type not found:

```json
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "Smart process not found"
  }
}
```

## 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 |
| 404 | `ENTITY_NOT_FOUND` | No type with that `entityTypeId` was found |
| 422 | `BITRIX_ERROR` | An error from Bitrix24. The specific reason is in the `message` field |

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

## See also

- [Type list](/docs/entities/smart-processes/list)
- [Create a type](/docs/entities/smart-processes/create)
- [Update a type](/docs/entities/smart-processes/update)
- [Delete a type](/docs/entities/smart-processes/delete)
- [Type fields](/docs/entities/smart-processes/fields)
- [Smart process items](/docs/entities/items)
- [Limits and optimization](/docs/optimization)