MeInfo

Information about the bot, including the list of workspaces the bot is a member of and the bot's profile information

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

]

workspacesstring[]required

Array of workspaceId values the bot is a member of

Example: [ADK5NyCqIK, BDK5NyCqIK]

updateApiVersionintegerrequired

API version through which the bot receives updates via the getUpdates method or webhooks. Can be 1 or 2

Example: 1

updateSettingsUpdateSetting (string)[]required

Settings apply only when receiving updates via API v2. Array of UpdateSetting values the bot receives. By default the bot receives the MESSAGE and WORKSPACE_INVITE types

Possible values: [MESSAGE, MESSAGE_ACTION, NOTIFICATION, WORKSPACE_INVITE]

autoAcceptWorkspaceInvitesbooleanrequired

The setting applies only when receiving updates via API v2. Sets whether the bot will automatically accept workspace invites. Default is false

Default value: false

Example: false

memberships object[]

Array of the bot's membershipId in each workspace. Allows the bot to learn its membershipId without sending messages

Array [

workspaceIdstringrequired

Workspace identifier

Example: ADK5NyCqIK

membershipIdstringrequired

The bot's member identifier (membershipId) in this workspace

Example: YKcsFqDNXk

]

scope objectrequired

Bot scope - defines which spaces the bot can operate in

typeBotScopeType (string)required

Bot scope type

Possible values: [pub, org, ws]

Example: org

organizationIdstring

Organization identifier (required for type=ORG)

Example: AIQffAsGi8

workspaceIdstring

Workspace identifier (required for type=WS)

Example: BIQffAsGi9

MeInfo

{
  "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"
        }
      ]
    }
  },
  "workspaces": "[ADK5NyCqIK, BDK5NyCqIK]",
  "updateApiVersion": "1",
  "updateSettings": [
    "MESSAGE"
  ],
  "autoAcceptWorkspaceInvites": "false",
  "memberships": [
    {
      "workspaceId": "ADK5NyCqIK",
      "membershipId": "YKcsFqDNXk"
    }
  ],
  "scope": {
    "type": "org",
    "organizationId": "AIQffAsGi8",
    "workspaceId": "BIQffAsGi9"
  }
}