Skip to main content

Get Campaign

Retrieve details about a specific campaign, including name, bid, status, app, and countries. Useful for syncing tools or editing flows.

L
Written by Lior Avidar
Updated over a week ago

Endpoint:
GET /v1/external/campaigns/:campaignId

Required Header:
Authorization: Bearer YOUR_API_TOKEN


Path Parameter:

  • campaignId (Number) – The unique ID of the campaign you want to retrieve


Example Request:
​​GET /v1/external/campaigns/123456
Header: Authorization: Bearer YOUR_API_TOKEN


Example Response:

{
"data": {
"id": 123456,
"name": "Summer Promo 2025",
"bid": 2.5,
"status": "Active",
"app_name": "GameXYZ",
"countries": ["US", "CA"],
"created_at": "2024-04-01T12:00:00Z",
"updated_at": "2024-05-03T14:15:00Z"
}
}

Returned Fields:

  • id: Campaign ID (integer)

  • name: Campaign name (string)

  • bid: Default bid value (float)

  • status: Active, Inactive, or other lifecycle stage

  • app_name: The app associated with the campaign

  • countries: Array of targeted countries (ISO 3166-1 alpha-2)

  • created_at: Timestamp of campaign creation (ISO 8601)

  • updated_at: Last modified timestamp (ISO 8601)


Possible Errors:

  • 404not found: No campaign with the specified ID

  • 403unauthorized: Invalid or missing token

  • 400invalid ID: Campaign ID must be a valid number

Did this answer your question?