Get Campaign Details

GET

https://platform-api.convirza.com/v3/campaigns/{id}

Campaigns

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

Fetches complete details for a single campaign by ID.

Response Structure
Returns all campaign fields including:

Campaign basic information (ID, name, status, dates, timezone)

Campaign spend and conversion tracking data

Associated organization unit and owner information

Referral phone number and settings

Creation and modification timestamps

Authorization
The campaign must be within the authenticated user's accessible hierarchy.

Example Request

GET /campaigns/1

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Path Params

Responses

🟢200

application/json

Successfully retrieved campaign details

Bodyapplication/json

🟠400

🟠401

🟠404

🔴500

Request Example

Shell

JavaScript

Java

Swift

curl --location --globoff 'https://platform-api.convirza.com/v3/campaigns/{id}' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Example 1

{
    "code": 200,
    "message": "Success",
    "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"
    },
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "timestamp": "2026-01-20T12:34:56.789Z"
}

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

Create Campaign

Update Campaign