GET/bots

Gets a list of bots that have been added.
If the number of bots is more than 50, use the cursor parameter in the previous results to continue to get the next list of bots.
For details of each bot, see Get bot details.

Authorization

oauth2

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

Scope

bot.read
bot

HTTP Request

GEThttps://www.worksapis.com/v1.0/bots

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
bots array (bots) 

Bot information

 
responseMetaData object (responseMetaData) 

Response metadata

 

bots

PropertyTypeDescription
botId integer 

Bot ID


required
format : int64 
botName string 

Bot name


required
maxLength : 100 
photoUrl string 

URL of a bot profile image (PNG format, 640 x 640 recommended and only HTTPS allowed)


required
maxLength : 1000 
i18nBotNames array (i18nBotNames) 

Multilingual bot name


minItems : 0 
i18nPhotoUrls array (i18nPhotoUrls) 

Multilingual bot image URLs


minItems : 0 

i18nBotNames

PropertyTypeDescription
language string 

Language code


required
Allowed values : ko_KR, ja_JP, en_US, zh_CN, zh_TW 
botName string 

Bot name


required
maxLength : 100 

i18nPhotoUrls

PropertyTypeDescription
language string 

Language code


required
Allowed values : ko_KR, ja_JP, en_US, zh_CN, zh_TW 
photoUrl string 

URL of a bot profile image


required
maxLength : 1000 

responseMetaData

PropertyTypeDescription
nextCursor string 

Cursor value for pagination


required 

Response Example

example

1{2  "bots": [3    {4      "botId": 2000001,5      "botName": "Example Bot",6      "photoUrl": "https://example.com/favicon.png",7      "i18nBotNames": [8        {9          "language": "en_US",10          "botName": "Example bot"11        }12      ],13      "i18nPhotoUrls": [14        {15          "language": "en_US",16          "photoUrl": "https://example.com/favicon.png"17        }18      ]19    }20  ],21  "responseMetaData": {22    "nextCursor": "JlIBsfJogXpzDGY8OscZziqZpYqCAu3RbZbaFzBb1od6lWQtSdPUd2FIdCuaGgu8DA=="23  }24}