SearchMembersResponse

Member search results

members object[]required

Array of MemberInfo of the found members

Array [

membershipIdstringrequired

Member ID within the workspace

Example: gIQffAsGi8

profile objectrequired

Member profile information

accountIdstringrequired

Account identifier

Example: AIQffAsGi8

emailstring

Email address

Example: i.ivanov@example.ru

createdAtstring<date-time>required

Date and time the account was created

Example: 2023-02-26T18:58:36.154+03:00

updatedAtstring<date-time>required

Date and time the account was last modified

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

fullNamestring

Display name

Example: John A. Smith

accountTypeAccountType (string)required

Account type

Possible values: [REGULAR, BOT, GUEST]

Example: REGULAR

accountDetails object

Additional user data

positionstring

Position

Example: Analyst

departmentstring

Department

Example: B2B

phoneNumberstring

Phone number

Example: 88001234567

locationAccountLocation (string)

Location

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

Example: OFFICE

biostring

Brief information

Example: Do not disturb after 8 PM

statusstring

Status

Example: On a business trip

customFields object[]

Arbitrary custom profile fields defined by the user. The order of elements is significant.

Array [

keystringrequired

Field name

Possible values: <= 64 characters

Example: telegram

valuestringrequired

Field value

Possible values: <= 256 characters

Example: @ivanov

]

createdAtstring<date-time>required

Date and time the member was created

Example: 2023-02-26T18:58:36.154+03:00

updatedAtstring<date-time>required

Date and time the member information was last modified

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

joinedAtstring<date-time>

Date and time the member joined the workspace

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

workspaceRoleWorkspaceRole (string)

Member's role in the workspace. GUEST - a guest invited to the space via a link, GUEST_CALLER - a guest invited to a call via a link

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

Example: ADMIN

presence objectrequired

Information about the member's online status

onlinebooleanrequired

Member is online

Example: true

onCallbooleanrequired

Member is on a call

Example: true

sincestring<date-time>required

Date and time the status was last changed

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

timeZonestring

Member's time zone ID

Example: Europe/Moscow

memberStatusMemberStatus (string)required

Member's status in the workspace. ACTIVE - active, PENDING - awaiting acceptance of the join invite, SUSPENDED - the member has been removed from the space

Possible values: [ACTIVE, PENDING, SUSPENDED]

Example: ACTIVE

leftAtstring<date-time>

Date and time the member was removed from the workspace

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

]

nextPageTokenstring

Next page token

prevPageTokenstring

Previous page token

allResultCountinteger<int64>required

Total number of results found

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": "John A. Smith",
        "accountType": "REGULAR",
        "accountDetails": {
          "position": "Analyst",
          "department": "B2B",
          "phoneNumber": "88001234567",
          "location": "OFFICE",
          "bio": "Do not disturb after 8 PM",
          "status": "On a business trip",
          "customFields": [
            {
              "key": "telegram",
              "value": "@ivanov"
            }
          ]
        }
      },
      "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
}