bots.listBotMembers

GET

/v1/bots/{botId}/members

curl --request GET \
  --url https://example.com/v1/bots/example/members \
  --header 'Authorization: Bearer <token>'

Lists the people who use this Bot in their own organizations. It needs bots.share.

Authorizations

• token
• session

Parameters

Path Parameters

botId

required

string

>= 1 characters <= 128 characters

Responses

200

Success

Media typeapplication/json

Array<object>

object

userId

required

string

organizationId

required

string

linked

required

string

>= 1 characters <= 128 characters

joinedAt

required

number

Example ^generated

[
  {
    "userId": "example",
    "organizationId": "example",
    "linked": "example",
    "joinedAt": 1
  }
]

400

BotInvalid | OrganizationRequired

Media typeapplication/json

Any of:

object

object

_tag

required

string

Allowed values: BotInvalid

message

required

string

object

object

_tag

required

string

Allowed values: OrganizationRequired

Example

{
  "_tag": "BotInvalid"
}

401

AuthenticationRequired

Media typeapplication/json

object

_tag

required

string

Allowed values: AuthenticationRequired

Example

{
  "_tag": "AuthenticationRequired"
}

403

@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin

Media typeapplication/json

Any of:

object

object

_tag

required

string

Allowed values: Forbidden

action

required

string

kind

required

string

field

string

reason

string

object

object

_tag

required

string

Allowed values: MembershipRequired

object

object

_tag

required

string

Allowed values: ForbiddenOrigin

Example

{
  "_tag": "Forbidden"
}

404

BotNotFound

Media typeapplication/json

object

_tag

required

string

Allowed values: BotNotFound

bot

required

string

Example

{
  "_tag": "BotNotFound"
}

409

@nmnmcc/ability/Authorizer/Pending | BotConflict

Media typeapplication/json

Any of:

object

object

_tag

required

string

Allowed values: Pending

ticket

required

string

reason

string

object

object

_tag

required

string

Allowed values: BotConflict

message

required

string

Example

{
  "_tag": "Pending"
}

429

RateLimited

Media typeapplication/json

object

_tag

required

string

Allowed values: RateLimited

retryAfterSeconds

required

integer

>= -9007199254740991 <= 9007199254740991

Example

{
  "_tag": "RateLimited"
}

503

BotStorageUnavailable | AuthenticationUnavailable | RequestFailed

Media typeapplication/json

Any of:

object

object

_tag

required

string

Allowed values: PolicyUnavailable

object

object

_tag

required

string

Allowed values: BotStorageUnavailable

object

object

_tag

required

string

Allowed values: AuthenticationUnavailable

object

object

_tag

required

string

Allowed values: RequestFailed

category

required

string

Allowed values: invalid forbidden not_found conflict unavailable external outcome_unknown interrupted

errorId

required

string

>= 1 characters <= 128 characters

Example

{
  "_tag": "PolicyUnavailable"
}