# getOnboardingState

Source: <https://telegafirst.com/docs/api-op-getonboardingstate>
Locale: ru
releaseGitSha: ea133cd4ad87fe549ef000b139be145be9bd1717
sourceContentDigest: 6a9d8accbd94c984e1f643cdb01a5d701cbc3e2dab2ac594c7ee50082774aede
Version: 2

# getOnboardingState

`GET /api/v1/tools/onboarding/state`

getOnboardingState

## Авторизация и права

Scopes: ALL. Auth alternatives: OR; scopes внутри альтернативы: ALL.

| Поле | Значение |
| - | - |
| security.0.hubApiKey | \[] |
| security.1.hubBearer | \[] |
| securitySchemes.hubApiKey.in | "header" |
| securitySchemes.hubApiKey.name | "X-Api-Key" |
| securitySchemes.hubApiKey.type | "apiKey" |
| securitySchemes.hubBearer.scheme | "bearer" |
| securitySchemes.hubBearer.type | "http" |
| x-required-scopes | \["onboarding:read"] |

## Параметры запроса

| Поле | Значение |
| - | - |
| 0.in | "query" |
| 0.name | "intent" |
| 0.required | false |
| 0.schema | [0.schema](https://telegafirst.com/docs/schema-91d349b2c983d5a96dfbf5f27ad81fd3a0e46ba4eabe6b36559fe3dbaa5deec1) |

## Тело запроса

| Поле | Значение |
| - | - |
| Тело запроса | null |

## Ответы

| Поле | Значение |
| - | - |
| 200.content.application/json.schema | [200.content.application/json.schema](https://telegafirst.com/docs/schema-ccf5f28148b17576a2ce4a1e7693650dd1bd35bdca6d8b82d1e14a0d1653c1b0) |
| 200.description | "Onboarding state and next action; intent defaults to auto. For a human, entry\_context distinguishes the active business, owned candidates and recommended action without switching the active pointer. new\_business requests personal creation guidance and is refused for API-key/M2M credentials. No tenant selector is accepted." |

## Ошибки

| Поле | Значение |
| - | - |
| 400.content.application/problem+json.schema | [ProblemDetails](https://telegafirst.com/docs/schema-c4113f3de00d728702a8663612e2074cbe3e8b3bb70d2b0dee6f3503fe89bd41) |
| 400.description | "Invalid onboarding entry intent or unknown query field." |
| 401.content.application/problem+json.schema | [ProblemDetails](https://telegafirst.com/docs/schema-c4113f3de00d728702a8663612e2074cbe3e8b3bb70d2b0dee6f3503fe89bd41) |
| 401.description | "Authentication required." |
| 403.content.application/problem+json.schema | [ProblemDetails](https://telegafirst.com/docs/schema-c4113f3de00d728702a8663612e2074cbe3e8b3bb70d2b0dee6f3503fe89bd41) |
| 403.description | "Onboarding read scope required." |

## Дополнительные условия

| Поле | Значение |
| - | - |
| operationId | "getOnboardingState" |
| tags | \["onboarding"] |
| x-idempotency | "none" |