Skip to main content
Version: Next

SearchMembersResponse

Результаты поиска участников

members object[]required

Массив из MemberInfo найденных участников

  • Array [
  • membershipIdstringrequired

    Id участника в рабочем пространстве

    Example: gIQffAsGi8
    profile objectrequired

    Информация о профиле участника

    accountIdstringrequired

    Идентификатор аккаунта

    Example: AIQffAsGi8
    emailstring

    Почтовый адрес

    Example: i.ivanov@example.ru
    createdAtstring<date-time>required

    Дата и время создания аккаунта

    Example: 2023-02-26T18:58:36.154+03:00
    updatedAtstring<date-time>required

    Дата и время последнего изменения аккаунта

    Example: 2024-02-26T18:58:36.154+03:00
    fullNamestring

    Отображаемое имя

    Example: Иванов Иван Иванович
    accountTypeAccountType (string)required

    Тип аккаунта

    Possible values: [REGULAR, BOT, GUEST]

    Example: REGULAR
    accountDetails object

    Дополнительные данные о пользователе

    positionstring

    Должность

    Example: Аналитик
    departmentstring

    Департамент

    Example: B2B
    phoneNumberstring

    Номер телефона

    Example: 88001234567
    locationAccountLocation (string)

    Место нахождения

    Possible values: [NOT_SET, OFFICE, HOME, VACATION]

    Example: OFFICE
    biostring

    Краткая информация

    Example: Не беспокоить после 20:00
    statusstring

    Статус

    Example: В командировке
    createdAtstring<date-time>required

    Дата и время создания участника

    Example: 2023-02-26T18:58:36.154+03:00
    updatedAtstring<date-time>required

    Дата и время последнего изменения информации об участнике

    Example: 2024-02-26T18:58:36.154+03:00
    joinedAtstring<date-time>

    Дата и время присоединения участника к рабочему пространству

    Example: 2024-02-26T18:58:36.154+03:00
    workspaceRoleWorkspaceRole (string)

    Роль участника в рабочем пространстве. GUEST - гость, приглашенный в пространство по ссылке, GUEST_CALLER - гость, приглашенный на звонок по ссылке

    Possible values: [MEMBER, ADMIN, OWNER, GUEST, GUEST_CALLER]

    Example: ADMIN
    presence objectrequired

    Информация об онлайн статусе участника

    onlinebooleanrequired

    Участник онлайн

    Example: true
    onCallbooleanrequired

    Участник на звонке

    Example: true
    sincestring<date-time>required

    Дата и время последнего изменения статуса

    Example: 2024-02-26T18:58:36.154+03:00
    timeZonestring

    Id временной зоны участника

    Example: Europe/Moscow
    memberStatusMemberStatus (string)required

    Статус участника в рабочем пространстве. ACTIVE - активный, PENDING - ожидание принятие приглашения на вступление, SUSPENDED - участник удален и пространства

    Possible values: [ACTIVE, PENDING, SUSPENDED]

    Example: ACTIVE
    leftAtstring<date-time>

    Дата и время исключения участника из рабочего пространства

    Example: 2024-02-26T18:58:36.154+03:00
  • ]
  • nextPageTokenstring

    Токен следующей страницы

    prevPageTokenstring

    Токен предыдущей страницы

    allResultCountinteger<int64>required

    Общее количество найденных результатов

    SearchMembersResponse
    {
    "members": [
    {
    "membershipId": "gIQffAsGi8",
    "profile": {
    "accountId": "AIQffAsGi8",
    "email": "i.ivanov@example.ru",
    "createdAt": "2023-02-26T18:58:36.154+03:00",
    "updatedAt": "2024-02-26T18:58:36.154+03:00",
    "fullName": "Иванов Иван Иванович",
    "accountType": "REGULAR",
    "accountDetails": {
    "position": "Аналитик",
    "department": "B2B",
    "phoneNumber": "88001234567",
    "location": "OFFICE",
    "bio": "Не беспокоить после 20:00",
    "status": "В командировке"
    }
    },
    "createdAt": "2023-02-26T18:58:36.154+03:00",
    "updatedAt": "2024-02-26T18:58:36.154+03:00",
    "joinedAt": "2024-02-26T18:58:36.154+03:00",
    "workspaceRole": "ADMIN",
    "presence": {
    "online": "true",
    "onCall": "true",
    "since": "2024-02-26T18:58:36.154+03:00"
    },
    "timeZone": "Europe/Moscow",
    "memberStatus": "ACTIVE",
    "leftAt": "2024-02-26T18:58:36.154+03:00"
    }
    ],
    "nextPageToken": "string",
    "prevPageToken": "string",
    "allResultCount": 0
    }