Skip to main content
GET
/
agent
/
list
List Agents
curl --request GET \
  --url https://api.getoutbox.ai/agent/list \
  --header 'Authorization: <api-key>'
{
  "results": [
    {
      "id": "<string>",
      "name": "<string>",
      "type": "chatbot",
      "variables": [
        {
          "variable": "<string>",
          "default": "<string>",
          "name": "<string>"
        }
      ]
    }
  ],
  "total": 123
}

Documentation Index

Fetch the complete documentation index at: https://docs.getoutbox.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Company API Key

Query Parameters

​
page
integer

Page number for pagination. If omitted, returns all results unpaginated. Page size is 10 items.

​
type
enum<string>
default:all

Filter by agent type

Available options:
all,
chat,
voice
​
search
string

Search term to filter agents by name (case-insensitive partial match)

Response

List of agents retrieved successfully

​
results
object[]
​
total
integer

Total count of agents matching filters