Получение списка приглашений агента
Метод API предназначен для получения списка приглашений агента.
Для вызова метода передать X-Login и X-Password в Headers запроса.
Для более точного поиска приглашений, можно использовать query параметры.
Запрос
Метод: GET https://business.selfwork.ru/selfemployed/business/v1/legal/get-invitations
Query Parameters
| Параметр | Тип | Описание |
|---|---|---|
| createdFrom | string | Дата начала выборки по дате создания, в формате: yyyy-MM-dd |
| createdTo | string | Дата окончания выборки по дате создания, в формате: yyyy-MM-dd |
| invitationId | integer | Идентификатор приглашения |
| page | int32 | Номер страницы, отсчёт с 1. Действует только вместе с pageSize |
| pageSize | int32 | Размер страницы. Без него метод вернёт весь список одним ответом |
| state | int32 | Статус |
| updatedAtFrom | string | Дата начала выборки по дате последнего обновления, в формате: yyyy-MM-dd |
| updatedAtTo | string | Дата окончания выборки по дате последнего обновления, в формате: yyyy-MM-dd |
Headers
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| X-Login | string | Да | Логин пользователя |
| X-Password | string | Да | Пароль пользователя |
Пример
- cURL
curl -X GET "https://business.selfwork.ru/selfemployed/business/v1/legal/get-invitations?createdFrom=2025-06-01&createdTo=2025-07-09&state=1&page=1&pageSize=50&updatedAtFrom=2025-06-15&updatedAtTo=2025-07-09" \
-H "X-Login: your_login_here" \
-H "X-Password: your_password_here" \
-H "Content-Type: application/json"
Ответы
- 200: OK
- 401: Unauthorized
- 500: Internal Server Error
Запрос выполнен успешно
[
{
"invitationId": 10,
"invitationScenarioId": 10,
"phone": "+78005553535",
"state": 3,
"meta": "some text here",
"created": "2022-01-22 00:00:00+7",
"updatedAt": "2022-01-22 00:00:00+7",
"individualId": 15
}
]
Описание ответа:
| Ключ | Описание |
|---|---|
| invitationId | Идентификатор приглашения в базе данных |
| invitationScenarioId | Идентификатор сценария в базе данных |
| phone | Номер телефона |
| state | Статусы приглашения |
| meta | Мета-информация |
| created | Дата и время создания |
| updatedAt | Дата и время обновления |
| individualId | Идентификатор самозанятого |
Справочник статусов
| Статус | Описание |
|---|---|
| 0 | Новый |
| 1 | Приглашение отправлено |
| 2 | Подключение к компании |
| 3 | Заполняется анкета |
| 4 | Проверка ПД (идентификация) |
| 5 | Ошибка проверки ПД |
| 6 | Ожидание подписания договора |
| 7 | Ожидание подписи компании |
| 8 | Готово |
| 9 | Отменено |
Не валидные авторизационные данные
{
"errorCode": 1,
"message": "Access denied"
}
Описание ошибки:
| Ключ | Описание |
|---|---|
| errorCode | Код ошибки, вернувшийся с сервера |
| message | Сообщение сервера, описывающее ошибку |
Системная ошибка
{
"errorCode": 100,
"message": "Internal server error"
}
Описание ошибки:
| Ключ | Описание |
|---|---|
| errorCode | Код ошибки, вернувшийся с сервера |
| message | Сообщение сервера, описывающее ошибку |