List Botsify Agents — Search and Filter Your Workspace

Retrieve a paginated list of all agents available in your Botsify workspace. You can narrow results by searching for an agent by name or by filtering to show only agents you own (my) versus agents shared with you (shared). All query parameters are optional — omitting them returns the first page of all agents.

Request

integer

The page number to retrieve. Defaults to 1 when omitted.

string

A partial or full agent name to search for. Returns only agents whose names match the provided string.

string

Filter agents by ownership. Accepted values:

my — return only agents you own
shared — return only agents shared with you

integer

The number of agents to return per page. Defaults to the server-side default when omitted.

Example

curl --request GET \
  --url 'https://app.botsify.com/api/v1/list-agents?page=1&tab=my&per-page=20' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Search by name:

curl --request GET \
  --url 'https://app.botsify.com/api/v1/list-agents?query=support&tab=my' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response

A successful 200 OK response returns a paginated list of agent objects.

Field	Type	Description
`data`	array	Array of agent objects for the current page.
`total`	integer	Total number of agents matching the query.
`per_page`	integer	Number of agents returned per page.
`current_page`	integer	The current page number.
`last_page`	integer	The total number of available pages.

{
  "data": [
    {
      "bot_id": "12345",
      "bot_name": "Support agent",
      "agent_type": "agent",
      "status": "active"
    }
  ],
  "total": 42,
  "per_page": 20,
  "current_page": 1,
  "last_page": 3
}

Authorization

Bots & Agents

Agent Versions

Messaging

Users & Analytics

WhatsApp

List Botsify Agents — Search and Filter Your Workspace

Request

Example

Response

​Request

​Example

​Response

Request

Example

Response