Skip to main content
GET
/
v1
/
external
/
campaigns
/
{agent_id}
cURL
curl --request GET \
  --url https://api.samora.ai/v1/external/campaigns/{agent_id} \
  --header 'X-API-Key: <api-key>'
{
  "message": "<string>",
  "data": {
    "campaigns": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "agent_name": "<string>",
        "retry_config": {
          "max_retries": 2,
          "retry_delay_minutes": 30,
          "retry_on": [
            "UNANSWERED",
            "REJECTED",
            "VOICEMAIL"
          ]
        },
        "call_stats": {
          "total": 123,
          "finished": 123,
          "pending": 123,
          "unanswered": 123,
          "failed": 123,
          "total_duration": "<string>"
        },
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      }
    ],
    "page": 123,
    "page_size": 123,
    "total": 123
  }
}

Authorizations

X-API-Key
string
header
required

Your unique organization API key. Required on all requests.

Path Parameters

agent_id
string<uuid>
required

The UUID of the AI agent that owns the campaign.

Query Parameters

page
integer
default:1
Required range: x >= 1
page_size
integer
default:10
Required range: 1 <= x <= 100

Search by campaign name.

status
enum<string>[]

Filter by campaign status. Repeat the query parameter for multiple statuses.

Available options:
DRAFT,
SCHEDULED,
IN_PROGRESS,
PAUSED,
FINISHED,
FAILED,
CANCELLED
sort_by
string
default:created_at
sort_dir
enum<string>
default:desc
Available options:
asc,
desc

Response

Campaigns fetched successfully

message
string
required
data
object
required