REST API · Launches
Get launch plan
A prepared plan: its recap and whether it was launched
GEThttps://api.apogee.ad/api/v1/launch-plans/{id}
Request
GET /launch-plans/{id} on https://api.apogee.ad/api/v1.
Path parameters
-
idstring path requiredLaunch plan id
Headers
-
Authorizationstring header requiredBearer apk_…: an API key with the scope of this route.
Response
200.
-
idstring -
statusstring -
recapobject -
defaults_appliedarray of strings -
warningsarray of strings -
created_atstring or null -
expires_atstring (date-time) -
launched_atstring or null -
launch_idstring or null
Every answer carries X-Request-Id (give it to support), Apogee-Version: 2026-10-06, and the RateLimit and RateLimit-Policy headers.
Errors
Errors are application/problem+json with a stable code to switch on (all the codes).
| Status | Possible codes |
|---|---|
| 400 Bad request | idempotency_key_required, not_supported, request_refused, validation_failed |
| 401 Unauthorized | invalid_api_key |
| 403 Forbidden | account_not_connected, forbidden, insufficient_scope, meta_permission_denied, platform_permission_denied, upgrade_required |
| 404 Not found | not_found |
| 429 Too many requests | daily_read_cap, meta_rate_limited, platform_rate_limited, quota_exceeded, rate_limited |
| 500 Internal server error | internal_error |
Example
With your key in APOGEE_API_KEY (create one):
curl 'https://api.apogee.ad/api/v1/launch-plans/120200000000000001' \
-H "Authorization: Bearer $APOGEE_API_KEY"{
"id": "120200000000000001",
"status": "prepared",
"recap": {},
"defaults_applied": [
"120200000000000001"
],
"warnings": [
"120200000000000001"
],
"created_at": "2026-10-23T09:00:00.000Z",
"expires_at": "2026-10-23T09:00:00.000Z",
"launched_at": "2026-10-23T09:00:00.000Z",
"launch_id": "9a4c1e7d-2f58-4b3a-8e60-1d5b7c9e3f20"
}Access and cost
| Plans | Pro and Scale. |
|---|---|
| Scope | read (scopes). |
| Credits | Free up to the daily free reads (5,000 a day on Pro, 10,000 on Scale), then 1 credit per read. A request that fails costs nothing, a replayed one neither (credits). |
| Rate limit | Read: 600 per 15 minutes on Pro, 1,200 on Scale (rate limits). |
| Daily cap | Counts 1 unit toward the 2,000 units one API key can use in 24 hours. |
Related operations
- Get launch questions:
POST /ad-accounts/{acc}/launch-questions - Create launch plan:
POST /launch-plans - Confirm launch plan:
POST /launch-plans/{id}/confirm - Get launch plan status:
GET /launch-plans/{id}/status - List launches:
GET /launches - Get launch:
GET /launches/{id}