Get Campaign By Id

Gets an campaign by its id

GET /api/v1/campaign/get/{campaign_id}

Get Campaign By Id

cURL

curl --request GET \
  --url 'https://api.example.com/api/v1/campaign/get/{campaign_id}?api_key='

200

{
  "message": "Data retrieved successfully",
  "meta": {},
  "data": {
    "name": "<string>",
    "start_time": "2023-11-07T05:31:56Z",
    "interval": 123,
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "widget_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "attributes": {},
    "status": "not_started",
    "execution_weekdays": [],
    "time_window_start": "<string>",
    "time_window_end": "<string>",
    "time_zone": "UTC",
    "enabled": false,
    "contacts": [],
    "widget_name": "<string>"
  }
}

Authorizations

Your API KeyHTTPBearer

api_key · string · query · required

Your API key for authentication. You can generate it from the Settings page. Format: starts with in-.

Path Parameters

campaign_id · string<uuid> · required

Response

200

application/json

Successful Response

message · string | null · default: Data retrieved successfully

meta · Meta · object

data · ICampaignRead · object

Show child attributes