Skip to main content
GET
/
api
/
ai
/
agent
/
list
List Agents
curl --request GET \
  --url https://app.aisync.link/api/ai/agent/list \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "agent_id": "<string>",
      "agent_name": "<string>",
      "status": "<string>",
      "general_prompt": "<string>",
      "weebhook_endpoint": "<string>",
      "weebhook_endpoint_method": "GET",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "current_page": 123,
  "per_page": 123,
  "total": 123
}

​
List Agents

Retrieve a paginated list of all AI agents associated with your account. Use this endpoint to get an overview of all your agents and their details.
​
page
integer
required
The page number to retrieve (starts from 1)
​
per_page
integer
required
Number of agents to return per page (maximum 100)
​
Authorization
string
required
Bearer token in the format: Bearer {access_token}
curl --location 'https://app.aisync.link/api/ai/agent/list?page=1&per_page=100' \
  --header 'Authorization: Bearer {{bearer_token}}'
​
data
array
Array of agent objects containing agent details
​
current_page
integer
The current page number
​
per_page
integer
Number of items per page
​
total
integer
Total number of agents available
Use pagination parameters to efficiently retrieve large lists of agents. The maximum number of agents per page is 100.

Authorizations

​
Authorization
string
header
required

Bearer token authentication. Include the access token in the Authorization header as 'Bearer {access_token}'

Query Parameters

​
page
integer
default:1
required

The page number to retrieve (starts from 1)

Required range: x >= 1
​
per_page
integer
default:100
required

Number of agents to return per page (maximum 100)

Required range: 1 <= x <= 100

Response

List of agents

​
data
object[]
required

Array of agent objects containing agent details

​
current_page
integer
required

The current page number

​
per_page
integer
required

Number of items per page

​
total
integer
required

Total number of agents available