REST API · Creatives
Get import
Where an import is; each COMPLETED file has its ref
GEThttps://api.apogee.ad/api/v1/imports/{id}
Request
GET /imports/{id} on https://api.apogee.ad/api/v1.
Path parameters
-
idstring path requiredImport id
Headers
-
Authorizationstring header requiredBearer apk_…: an API key with the scope of this route.
Response
200.
-
idstring -
sourcestring -
jobsarray of objectsFields of each item (7)
-
idstring -
namestring or null -
statusstring -
progressnumber or null -
size_bytesnumber or null -
refstring or null -
errorstring or null
-
-
doneboolean -
created_atstring or null -
notestringWhy an import has no file (done at once)
-
truncatedboolean -
skipped_too_largearray of values
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/imports/120200000000000001' \
-H "Authorization: Bearer $APOGEE_API_KEY"{
"id": "120200000000000001",
"source": "frameio",
"share_name": "Nordlicht | Spring launch",
"done": false,
"created_at": "2026-10-23T09:00:00.000Z",
"note": "Example text",
"jobs": [
{
"id": "120200000000000001",
"name": "Nordlicht | Spring launch",
"status": "PENDING",
"progress": 100,
"size_bytes": 48213112,
"ref": "120200000000000001",
"error": "120200000000000001"
}
],
"truncated": false,
"skipped_too_large": [
"120200000000000001"
]
}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). |
In the MCP
An AI assistant does the same with this tool of the MCP server:
import_status: The progress of an import. Each finished file gets areffor the launch.
Related operations
- Create import:
POST /imports - List drive folder:
GET /drive-folders - Create uploads:
POST /uploads - Confirm uploads:
POST /uploads/confirm - List TikTok posts:
GET /ad-accounts/{acc}/tiktok-posts - List TikTok music:
GET /ad-accounts/{acc}/tiktok-music - List platform templates:
GET /ad-accounts/{acc}/platform-templates