Get a list of all Campaigns for a specific Convoso instance.
Endpoint:
GET https://api.convoso.com/v1/campaigns/search
đź”’ Authentication
- Parameter Name: auth_token
- Type: Query Parameter
- Required: Yes
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| auth_token | string | âś… Yes | authorization token |
Example Request
GET https://api.convoso.com/v1/campaigns/search?auth_token=YOUR_AUTH_TOKEN
Response Format (JSON)
{
"success": true,
"data": [
{
"id": 2999,
"name": "Default Campaign: Default",
"status": "N",
"last_call_date": null
},
{
"id": 3001,
"name": "Main Outbound",
"status": "Y",
"last_call_date": {
"date": "2025-06-03 12:59:52.000000",
"timezone_type": 3,
"timezone": "America/Los_Angeles"
}
}
]
}
Response Field Definitions
Response Top-Level Object
| Field | Type | Description |
|---|---|---|
| success | boolean | Indicates if the request was successful. |
| data | array | List of campaign objects. |
Campaign Object
| Field | Type | Description |
|---|---|---|
| id | integer | Unique identifier for the campaign. |
| name | string | Name of the campaign. |
| status | string | "Y" = active, "N" = inactive. |
| last_call_date | object|null | Last call timestamp and timezone info, or null if no calls. |
Last Call Object
| Field | Type | Description |
|---|---|---|
| date | string | Timestamp of last call in YYYY-MM-DD HH:mm:ss.ffffff format. |
| timezone_type | integer | PHP timezone type (typically 3 for identifier-based). |
| timezone | string | Timezone identifier (e.g., America/Los_Angeles). |