GET/bots/{botId}/domains/{domainId}/members

Gets a list of allowed users in a bot's domain.
If the number of users is more than 50, use the cursor parameter in the previous results to continue to get the next list of users.
It returns "All users" if all the users are allowed.

Authorization

oauth2

OAuth 2.0 authentication.
For more information, see Authentication and Authorization.

Scope

bot
bot.read

HTTP Request

GEThttps://www.worksapis.com/v1.0/bots/{botId}/domains/{domainId}/members

Path Parameters

ParameterTypeDescription
botId integer 

Bot ID


required
example : 2000001
format : int64 
domainId integer 

Domain ID


required
example : 10000001
format : int64 

Query Parameters

ParameterTypeDescription
cursor string 

Cursor value for pagination


example : JlIBsfJogXpzDGY8OscZziqZpYqCAu3RbZbaFzBb1od6lWQtSdPUd2FIdCuaGgu8DA== 
count integer 

Number of items in a list


default : 50
minimum : 1
maximum : 100
example : 60
format : int64 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Response

HTTP 200

OK

PropertyTypeDescription
members array (string) 

List of members who are allowed to use the bot

 
responseMetaData object (responseMetaData) 

Response metadata

 

responseMetaData

PropertyTypeDescription
nextCursor string 

Cursor value for pagination


required 

Response Example

example

1{2  "members": [3    "userf7da-f82c-4284-13e7-030f3b4c756x"4  ],5  "responseMetaData": {6    "nextCursor": "JlIBsfJogXpzDGY8OscZziqZpYqCAu3RbZbaFzBb1od6lWQtSdPUd2FIdCuaGgu8DA=="7  }8}