API reference
List campaigns
GET /v1/campaigns
Your campaigns, newest first, each with how many of its contacts are in each state. Filter by agent_id and status. A test key lists none: every campaign is live. Needs campaigns:read.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
agent_id |
query | string (uuid) or null | No | Only this agent's. |
status |
query | CampaignStatus or null | No | Only campaigns in this state. |
limit |
query | integer | No | How many to return, 1 to 100. |
cursor |
query | string or null | No | next_cursor from the previous page, with the same filters. |
Answer
200 with CampaignList.
Errors
Every error is a problem document with a stable code.
| Status | When |
|---|---|
401 |
The key is missing, mistyped, unknown, revoked or expired. |
403 |
The key lacks a permission, a live key was sent from a browser, or the organization is frozen and the request would change something. |
422 |
Validation Error |
429 |
Too many requests for this key or its organization; see Retry-After. |
500 |
Something went wrong on our side. Quote the request_id to support. |
Examples
#!/bin/sh
# List campaigns
curl -sS --fail-with-body -X GET "https://api.aigently.ai/v1/campaigns?limit=10" \
-H "Authorization: Bearer $AIGENTLY_API_KEY"
Try it
Sends this request to the API from your browser, with a test key. Nothing it does rings a phone.