Skip to main content
GET
/
api
/
v1
/
vendors
/
{vendorId}
/
organizations
/
{organizationId}
/
agents
List Agents
curl --request GET \
  --url https://app.phonebot.io:80/api/v1/vendors/{vendorId}/organizations/{organizationId}/agents
{
  "success": true,
  "page": 0,
  "size": 20,
  "totalElements": 100,
  "totalPages": 5,
  "timestamp": "2025-04-17T14:23:30Z",
  "message": "<string>",
  "data": [
    {
      "id": "98765432-10fe-dcba-9876-543210fedcba",
      "name": "Support Bot Beta"
    }
  ],
  "traceId": "<string>"
}

Path Parameters

​
vendorId
string
required

ID of the Vendor (UUID)

​
organizationId
string
required

ID of the Organization (UUID)

Query Parameters

​
page
integer
default:0

Page number of the requested page (0-indexed)

​
size
integer
default:20

Number of items per page

​
sort
string
default:name,asc

Sorting criteria in the format: property,(asc|desc). Default sort is 'name,asc'. Multiple sort criteria are supported.

Response

Successfully retrieved the list of agents

Paged API response wrapper

​
success
boolean
required

Indicates if the request was successful

Example:

true

​
page
integer<int32>
required

Current page number (0-indexed)

Example:

0

​
size
integer<int32>
required

Size of each page

Example:

20

​
totalElements
integer<int64>
required

Total number of elements

Example:

100

​
totalPages
integer<int32>
required

Total number of pages

Example:

5

​
timestamp
string<date-time>
required

Response timestamp in ISO-8601 format

Example:

"2025-04-17T14:23:30Z"

​
message
string

Human-readable message

​
data
object[]

List of data items

​
traceId
string

Correlation or trace ID