Get campaign by ID

GET

/campaign/{id}

Retrieves a specific campaign by its ID

Request

Authorization

API Key

Add parameter in header

api-key

Example:

api-key: ********************

Path Params

Responses

🟢200

application/json

Successful response

Body

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET '/campaign/' \
--header 'api-key: <api-key>'

Response Example

{
    "Mode": true,
    "BusinessName": "string",
    "CallType": "string",
    "CompanyName": "string",
    "FirstMessage": "string",
    "IsActive": true,
    "PartitionKey": "string",
    "PhoneNumberId": "string",
    "Position": "string",
    "RowKey": "string",
    "ScriptBase": "string",
    "ScriptNotes": "string",
    "StartDate": "2019-08-24T14:15:22.123Z",
    "TimeWindows": "string",
    "SuccessRequest": 0,
    "TemplateId": "string",
    "Timestamp": "2019-08-24T14:15:22.123Z",
    "TotalRequest": 0,
    "TotalTransfers": 0,
    "campaignType": "string",
    "name": "string",
    "odata.etag": "string",
    "DailyCallLimit": 0,
    "KnowledgeBaseId": "string",
    "KnowledgeBaseProvider": "string",
    "TrieveDataSetId": "string",
    "FeatureAppendPreviousSummaryEnabled": true,
    "PhoneNumberProvider": "string",
    "FeatureRescheduleCallEnabled": true,
    "EnrichmentInfoSettings": "string",
    "EnrichmentInfoProvider": "string",
    "FeatureEnrichmentInfoEnabled": true,
    "EndCallMessage": "string",
    "VoicemailMessage": "string",
    "AnalysisPlanSummaryPrompt": "string",
    "FeatureEndCallWhenVoicemail": true,
    "FeatureRedialOnNoResponse": true,
    "RedialSettings": "string",
    "FeatureDoubleCall": true,
    "Timezone": "string",
    "TimezoneFriendlyName": "string",
    "Status": "archived",
    "Collection": "string",
    "IdleMessages": "string",
    "ToolIds": "string",
    "SMSTrigger": "string",
    "SMSBody": "string"
}

Modified at 2025-12-29 23:44:15

Get all campaigns

Get call records