Skip to main content
GET
List Agents

Authorizations

Authorization
string
header
required

Access Token or Private Integration Token

Headers

Version
enum<string>
required

API Version

Available options:
2021-04-15

Query Parameters

page
number
default:1

Page number starting from 1

Required range: 1 <= x <= 5000
Example:

1

pageSize
number
default:10

Number of items per page

Required range: 1 <= x <= 50
Example:

10

locationId
string
required

Location ID

query
string

Query

Response

Agent list retrieved successfully.

total
number
required

Total number of items

Example:

150

page
number
required

Page number starting from 1

Example:

2

pageSize
number
required

Number of items per page

Example:

10

agents
object[]
required
Last modified on March 7, 2026