Get Campaign by ID

GET

https://apicfa.convirza.com/v2/campaign

Campaign

Last modified:2026-04-03 12:54:09

Retrieves detailed configuration for a specific campaign by ID. Returns campaign settings including tracking numbers, routing rules, business hours, geographic targeting, and performance analytics configuration.

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

Campaign configuration with settings, tracking numbers, and routing rules

Headers

Body

🟠400

🟠401

🟠403

🟠404

🔴500

⚪default

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://apicfa.convirza.com/v2/campaign?id&display_referral' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Example 1

{
    "campaign_id": 0,
    "campaign_name": "string",
    "campaign_ext_id": "string",
    "campaign_status": "active",
    "campaign_created": "2019-08-24T14:15:22.123Z",
    "campaign_modified": "2019-08-24T14:15:22.123Z",
    "campaign_start_date": "2019-08-24T14:15:22.123Z",
    "campaign_end_date": "2019-08-24T14:15:22.123Z",
    "campaign_owner_user_id": 1,
    "group_id": 1,
    "referral_service": {
        "referral_enabled": true,
        "ringto_phone_number": 0
    },
    "owner_fname": "string",
    "owner_lname": "string",
    "campaign_routes": [
        {
            "call_flow_id": 0,
            "route_type": "ringto",
            "call_flow_name": "string",
            "call_flow_created": "2019-08-24T14:15:22.123Z",
            "call_flow_modified": "2019-08-24T14:15:22.123Z",
            "call_flow_status": "active",
            "repeat_interval": 0,
            "call_value": "string"
        }
    ],
    "campaign_users": [
        {
            "ct_user_id": 0,
            "user_ext_id": "string",
            "first_name": "string",
            "last_name": "string",
            "user_title": "string",
            "user_status": "active",
            "role_id": 1,
            "group_id": 1,
            "user_email": "string",
            "password": "pa$$word",
            "aliases": "string",
            "timezone": "America/Halifax"
        }
    ]
}

Modified at 2026-04-03 12:54:09

Update Webhook

Create Campaign