REST API · Actions

Get action

A prepared action: what it will do, and whether it ran

GEThttps://api.apogee.ad/api/v1/actions/{id}

Scope: read Pro and Scale plans Credits: Free*

Request

GET /actions/{id} on https://api.apogee.ad/api/v1.

Path parameters

id string path required

Action id

1 to 64 characters

Matches ^[\w-]+$

Headers

Authorization string header required

Bearer apk_…: an API key with the scope of this route.

Response

200.

id string
status string

One of prepared, done, expired
type string or null
platform string

One of meta, tiktok, snapchat
ad_account_id string or null
will_do string or null
created_at string or null
expires_at string (date-time)
executed_at string 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):

Request

curl 'https://api.apogee.ad/api/v1/actions/120200000000000001' \
  -H "Authorization: Bearer $APOGEE_API_KEY"

Response 200 (shape)

{
  "id": "120200000000000001",
  "type": "120200000000000001",
  "platform": "meta",
  "ad_account_id": "act_1234567890",
  "status": "prepared",
  "will_do": "Pause 1 ad in act_1234567890: Nordlicht | Spring launch.",
  "created_at": "2026-10-23T09:00:00.000Z",
  "expires_at": "2026-10-23T09:00:00.000Z",
  "executed_at": "2026-10-23T09:00:00.000Z"
}

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.

Create action: POST /actions
Confirm action: POST /actions/{id}/confirm

Request

Path parameters

Headers

Response

Errors

Example

Access and cost

Related operations