Skip to main content
GET
List
searchKey matches the start of a bot’s UID, not its name. Results are ordered by UID. perPage defaults to 100 and is capped at 1000. Page through the results rather than assuming one response holds every bot.

Listing AI bots

isAIBot defaults to false, so this endpoint returns standard bots only. Pass isAIBot=true to list bots flagged as AI bots instead — there is no call that returns both at once. Agents created through AI Agents are not returned either way. A GET /bots?isAIBot=true response looks like this:
isAIBot appears only when it is true, because responses omit every property whose value is empty or false. That is also why order-bot in the response example has no useBasicAuth, username or password.
Every bot with a stored password returns it in this response, including bots whose useBasicAuth was later set to false. A single call can therefore expose the basic auth credentials of every bot in the app. The examples mask the value as ********.
For the complete error reference, see Error Guide.

Authorizations

apikey
string
header
required

API Key with fullAccess scope(i.e. Rest API Key from the Dashboard).

Query Parameters

searchKey
string

Performs a LIKE% query, searching for bot UIDs starting with the specified characters.

isAIBot
boolean
default:false

Returns only bots flagged as AI bots instead of standard bots. Defaults to false. Agents created through AI Agents are not returned either way.

perPage
integer
default:100

Number of bots to be fetched in a request. The default value is 100 and the maximum value is 1000.

page
integer
default:1

Page Number.

Response

200 - application/json

Lists the bots

data
any[]
meta
object