GET/bots/{botId}/domains

Gets a list of domains to which a bot is added.

If the number of domains is more than 50, use the cursor parameter in the previous results to continue to get the next list of domains.

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

Path Parameters

ParameterTypeDescription
botId integer 

Bot ID


required
example : 2000001
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
domains array (BotDomain) 

List of domains

 
responseMetaData object (responseMetaData) 

Response metadata

 

BotDomain

PropertyTypeDescription
domainId integer 

Domain ID


format : int64
readOnly : true 
visible boolean 

Indicates whether to make the bot visible on the customer's organization chart.


default : false 
allowToSelectedMember boolean 

Indicates whether to allow only specified members to use the bot.


default : false 

responseMetaData

PropertyTypeDescription
nextCursor string 

Cursor value for pagination


required 

Response Example

example

1{2  "domains": [3    {4      "domainId": 10000001,5      "visible": true,6      "allowToSelectedMember": true7    }8  ],9  "responseMetaData": {10    "nextCursor": "JlIBsfJogXpzDGY8OscZziqZpYqCAu3RbZbaFzBb1od6lWQtSdPUd2FIdCuaGgu8DA=="11  }12}