Retrieve a campaign
Reads one synced campaign by the platform's id.
Needs project:ads:read.
Guide: Ads reports
AuthorizationBearer <token>
A project secret key: vh_sk_... for production, vh_sk_test_... for test. Keep it on your servers.
In: header
Path parameters
projectId*string
The project's id, proj_.... A secret key works only in the project it belongs to.
campaignId*string
The platform's id of the campaign.
Examples
curl -X GET "https://api.voidhash.com/api/v1/projects/proj_tz4a98xxat96iws9zmbrgj3a/ads/campaigns/120210000000000001" \ -H "Authorization: Bearer vh_sk_..."{ "projectId": "proj_tz4a98xxat96iws9zmbrgj3a", "adAccountId": "ad_acct_k3m9x2c7v1b8n4q6w0e5r2t7", "platform": "meta", "status": "on", "deliveryStatus": "delivering", "deliveryReasons": [], "destination": "web_to_app", "budget": { "amount": 20000, "currency": "USD", "period": "daily", "level": "campaign" }, "startsAt": "2026-02-28T23:00:00.000Z", "endsAt": null, "createdAt": "2026-02-27T14:10:00.000Z", "updatedAt": "2026-03-14T08:52:00.000Z", "syncedAt": "2026-03-14T10:00:12.000Z", "id": "120210000000000001", "name": "Spring trial", "platformUrl": "https://adsmanager.facebook.com/adsmanager/manage/campaigns?act=1234567890&selected_campaign_ids=120210000000000001", "objective": "sales", "bidStrategy": "lowest_cost", "spendCap": null}{ "error": { "type": "invalid_request", "code": "string", "message": "string", "param": "string" }}{ "error": { "type": "unauthenticated", "code": "invalid_api_key", "message": "This secret key is not valid." }}{ "error": { "type": "permission_denied", "code": "permission_denied", "message": "Insufficient permissions." }}{ "error": { "type": "not_found", "code": "campaign_not_found", "message": "This project has no synced campaign 120210000000000001.", "param": "campaignId" }}{ "error": { "type": "internal", "code": "internal_error", "message": "Something went wrong on our side. Try again, and contact support with the Request-Id header if it keeps failing." }}Response body
application/json
application/json
application/json
application/json
application/json
application/json
Errors
| Status | type | code | When |
|---|---|---|---|
| 404 | not_found | campaign_not_found | — |
It can also fail with the errors every operation shares, such as unauthenticated; see Errors.
More in Ads
- List campaigns
GET - List ad groups
GET - Retrieve an ad group
GET - List ads
GET - Retrieve an ad
GET - Preview a creative
GET - Retrieve ads settings
GET - Update ads settings
PATCH - Report ad performance
POST - Report creatives
POST - Report ad cohorts
POST - Report ad changes
POST
Something wrong or missing on this page? Tell us by email or on Discord.