List Campaigns

GET

https://platform-api.convirza.com/v3/campaigns

Campaigns

Last modified:2026-07-24 13:10:44

Returns all campaigns with optional filtering by organization unit, name, or status.

Filtering Options

org_unit_id — filter campaigns by organization unit ID.

campaign_name — partial, case-insensitive match against the campaign name.

status — filter by campaign status (active, inactive, deleted, suspended, referral).

limit — maximum number of campaigns to return (default: 10, max: 200).

offset — number of campaigns to skip for pagination (default: 0).

Response
Each campaign record includes:

Basic campaign information (ID, name, status, dates)

Organization and owner details

Campaign spend and conversion tracking data

Referral phone number (if applicable)

Example Request

GET /campaigns?org_unit_id=1001&status=active&limit=50

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Query Params

Responses

🟢200

application/json

Successfully retrieved campaigns

Bodyapplication/json

🟠400

🟠401

🔴500

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://platform-api.convirza.com/v3/campaigns?offset=&limit=&sort_by=&sort_order=&org_unit_id=&campaign_name=&status=' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Example 1

{
    "code": 200,
    "message": "Success",
    "data": {
        "data": [
            {
                "campaign_id": 1,
                "campaign_name": "Summer Sale 2026",
                "external_id": 12345,
                "status": "active",
                "start_date": "2026-06-01T09:00:00-04:00",
                "end_date": "2026-08-31T17:00:00-04:00",
                "timezone": "America/New_York",
                "owner_user_id": 101,
                "org_unit_id": 1001,
                "referral_pnumber": "1234567890",
                "campaign_spend": 5000,
                "conversion_value": 150,
                "campaign_spend_frequency": "one_time",
                "created_at": "2026-01-15T15:30:00.000Z",
                "modified_at": "2026-03-20T18:45:00.000Z"
            }
        ],
        "total": 25
    },
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "timestamp": "2026-01-20T12:34:56.789Z"
}

Modified at 2026-07-24 13:10:44

Update Call Action Template

Create Campaign