Перейти к основному содержимому

Участники

Фильтр участников​

Метод API предназначен для поиска и получения списка участников организации с использованием расширенных фильтров. Требует доступ org.members.read.

Запрос​

Метод: POST URL: https://b2b.selfwork.ru/openapi/v2/organisation/{organisationId}/members/filter

Path Parameters​

ПараметрТипОбязательное полеОписаниеПример
organisationIdstring (uuid)ДаID организации550e8400-e29b-41d4-a716-446655440000

Общая структура запроса описана в разделе Фильтрация: общая структура.

Доступные фильтры (filters)​

Имя (name)Тип значения (value)Описание
USER_IDstring (uuid) или массивID пользователя
ROLE_IDstring (uuid) или массивID роли (см. раздел «Роли»)
STATUSstring или array[string]Статус участника: ACTIVE, ARCHIVED

Организация всегда берётся из пути, фильтр ORGANISATION_ID передавать не нужно.

Доступные сортировки (order)​

Поле (field)Описание
JOINED_ATДата вступления в организацию
CREATED_ATДата создания записи участника

Пример запроса​

curl --location "https://b2b.selfwork.ru/openapi/v2/organisation/550e8400-e29b-41d4-a716-446655440000/members/filter" \
--header "accept: application/json" \
--header "Content-Type: application/json" \
--header "Authorization: Bearer ВАШ_API_КЛЮЧ" \
--data '{
"filters": [],
"pagination": {
"limit": 10,
"lastId": null
}
}'

Пример успешного ответа​

{
"requestId": "97c5678a-8c6a-4688-8452-68ab606fe049",
"success": true,
"result": {
"lastId": "01961a2b-0001-7e5f-8a9b-0c1d2e3f4a5b",
"items": [
{
"id": "01961a2b-0001-7e5f-8a9b-0c1d2e3f4a5b",
"roles": [
{
"id": "01961a2b-0010-7e5f-8a9b-0c1d2e3f4a5b",
"memberId": "01961a2b-0001-7e5f-8a9b-0c1d2e3f4a5b",
"roleId": "019d06af-5e5d-7313-b8ba-df1640767435",
"roleCode": "OWNER",
"roleName": "Владелец",
"active": true,
"createdAt": "2026-03-17T12:00:00Z"
}
],
"joinedAt": "2026-03-17T12:00:00Z",
"createdAt": "2026-03-17T12:00:00Z",
"updatedAt": "2026-03-17T12:00:00Z",
"email": "user@example.com",
"firstName": "Иван",
"lastName": "Иванов",
"middleName": "Иванович"
}
]
}
}

Описание полей ответа​

ПолеТипОписание
requestIdstringУникальный идентификатор запроса
successbooleanСтатус выполнения запроса (true/false)
resultobjectКонтейнер с данными ответа
result.lastIdstring|numberID последнего элемента в текущем списке (для пагинации)
result.itemsarray[obj]Массив найденных участников
idstring (uuid)Идентификатор членства
rolesarray[obj]Роли участника в организации (см. поля роли ниже)
joinedAtstringДата вступления
createdAtstringДата создания записи
updatedAtstringДата обновления
emailstring (email)Email пользователя
firstNamestringИмя пользователя
lastNamestringФамилия пользователя
middleNamestringОтчество пользователя

 

Деталка участника​

Метод API возвращает подробную информацию об одном участнике организации. Требует доступ org.members.read.

Запрос​

Метод: GET URL: https://b2b.selfwork.ru/openapi/v2/organisation/{organisationId}/members/{memberId}

Path Parameters​

ПараметрТипОбязательное полеОписаниеПример
organisationIdstring (uuid)ДаID организации550e8400-e29b-41d4-a716-446655440000
memberIdstringДаИдентификатор участника01961a2b-0001-7e5f-8a9b-0c1d2e3f4a5b

Пример запроса​

curl -X 'GET' \
"https://b2b.selfwork.ru/openapi/v2/organisation/550e8400-e29b-41d4-a716-446655440000/members/01961a2b-0001-7e5f-8a9b-0c1d2e3f4a5b" \
-H "accept: application/json" \
-H "Authorization: Bearer ВАШ_API_КЛЮЧ"

Пример успешного ответа​

{
"requestId": "97c5678a-8c6a-4688-8452-68ab606fe049",
"success": true,
"result": {
"id": "01961a2b-0001-7e5f-8a9b-0c1d2e3f4a5b",
"roles": [
{
"id": "01961a2b-0010-7e5f-8a9b-0c1d2e3f4a5b",
"memberId": "01961a2b-0001-7e5f-8a9b-0c1d2e3f4a5b",
"roleId": "019d06af-5e5d-7313-b8ba-df1640767435",
"roleCode": "OWNER",
"roleName": "Владелец",
"active": true,
"createdAt": "2026-03-17T12:00:00Z"
}
],
"joinedAt": "2026-03-17T12:00:00Z",
"createdAt": "2026-03-17T12:00:00Z",
"updatedAt": "2026-03-17T12:00:00Z",
"email": "user@example.com",
"firstName": "Иван",
"lastName": "Иванов",
"middleName": "Иванович"
}
}

Описание полей ответа​

ПолеТипОписание
requestIdstringУникальный идентификатор запроса
successbooleanСтатус выполнения запроса (true/false)
resultobjectОбъект участника (MemberInfoApiDto)
idstring (uuid)Идентификатор членства
rolesarray[obj]Роли участника в организации (см. поля роли ниже)
joinedAtstringДата вступления
createdAtstringДата создания записи
updatedAtstringДата обновления
emailstring (email)Email пользователя
firstNamestringИмя пользователя
lastNamestringФамилия пользователя
middleNamestringОтчество пользователя

Поля роли (объект roles[])​

ПолеТипОписаниеПример
idstring (uuid)Идентификатор назначения01961a2b-0010-7e5f-8a9b-0c1d2e3f4a5b
memberIdstring (uuid)Идентификатор членства01961a2b-0001-7e5f-8a9b-0c1d2e3f4a5b
roleIdstring (uuid)Идентификатор роли019d06af-5e5d-7313-b8ba-df1640767435
roleCodestringТехнический код ролиOWNER
roleNamestringЧеловекочитаемое название ролиВладелец
activebooleanАктивность назначенияtrue
createdAtstringДата создания2026-03-17T12:00:00Z

 

Редактирование роли​

Метод API позволяет деактивировать или реактивировать назначенную участнику роль. Требует доступ org.members.roles.edit.

Запрос​

Метод: PATCH URL: https://b2b.selfwork.ru/openapi/v2/organisation/{organisationId}/members/{memberId}/roles/{memberRoleId}

Path Parameters​

ПараметрТипОбязательное полеОписаниеПример
organisationIdstring (uuid)ДаID организации550e8400-e29b-41d4-a716-446655440000
memberIdstringДаИдентификатор участника01961a2b-0001-7e5f-8a9b-0c1d2e3f4a5b
memberRoleIdstringДаИдентификатор роли участника01961a2b-0010-7e5f-8a9b-0c1d2e3f4a5b

Request Body​

ПолеТипОбязательное полеОписание
activebooleanДаДеактивация (false) / реактивация (true)

Пример запроса​

curl -X 'PATCH' \
"https://b2b.selfwork.ru/openapi/v2/organisation/550e8400-e29b-41d4-a716-446655440000/members/01961a2b-0001-7e5f-8a9b-0c1d2e3f4a5b/roles/01961a2b-0010-7e5f-8a9b-0c1d2e3f4a5b" \
-H "accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ВАШ_API_КЛЮЧ" \
-d '{
"active": false
}'

Пример успешного ответа​

{
"requestId": "97c5678a-8c6a-4688-8452-68ab606fe049",
"success": true,
"result": {
"id": "01961a2b-0010-7e5f-8a9b-0c1d2e3f4a5b",
"memberId": "01961a2b-0001-7e5f-8a9b-0c1d2e3f4a5b",
"roleId": "019d06af-5e5d-7313-b8ba-df1640767435",
"roleCode": "OWNER",
"roleName": "Владелец",
"active": false,
"createdAt": "2026-03-17T12:00:00Z"
}
}

Описание полей ответа​

ПолеТипОписание
requestIdstringУникальный идентификатор запроса
successbooleanСтатус выполнения запроса (true/false)
resultobjectОбъект назначения роли (MemberRoleInfoDto)
idstring (uuid)Идентификатор назначения
memberIdstring (uuid)Идентификатор членства
roleIdstring (uuid)Идентификатор роли
roleCodestringТехнический код роли
roleNamestringЧеловекочитаемое название роли
activebooleanАктивность назначения
createdAtstringДата создания