Ad Groups

List ad groups

GET
/api/v1/accounts/{projectId}/ad-groups

Ad groups with performance, default bid, CPA goal, Search Match opt-in and targeting. Targeting is set membership — Apple has no bid modifiers, so to bid differently on a segment you split it into its own ad group.

Lists rank by spend and truncate at limit — they are not paginated. There is no cursor: the ranking happens after the stats join, so a keyset cursor would skip or duplicate rows. Raise limit or narrow with campaignId.

Required scope: read.

Authorization

bearerAuth
AuthorizationBearer <token>

An API key from Workspace → Settings → API keys, sent as Authorization: Bearer tsk_….

Authorization has two independent axes.

The scope is ranked — a key satisfies any requirement at or below its own tier:

  • read — see state. Never changes anything.
  • write — propose changes (the actions/* endpoints), trigger audits and reports.
  • admin — connection, account import, sync, targets and brief.

There is no approve scope. It was a rung once; it is not one now, and a key requested with it is rejected.

The approval grant (can_approve) is a separate boolean, not a rung. Deciding a queued proposal — approve, reject, revert — needs write and the grant. Keeping them on separate axes is what makes the review gate a control rather than a convention: a key that may propose is not automatically a key that may approve its own proposal.

A key is either org-scoped (reaches every account, optionally limited to a subset) or bound to a single account.

In: header

Path Parameters

projectId*string

The account's project UUID — from GET /accounts, NOT the Apple asaOrgId. Pass the literal current with an account-scoped key to use its bound account.

Query Parameters

campaignId?string

Restrict to one campaign.

days?integer

Look-back window in days. Anchors at YESTERDAY, not today — Apple's current-day numbers are incomplete.

Range1 <= value <= 90
Default30
limit?integer

Maximum rows to return. Lists rank by spend and truncate; check total and truncated.

Range1 <= value <= 200
Default100

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/accounts/current/ad-groups"
{  "currency": "string",  "adGroups": [    {}  ],  "total": 0,  "truncated": true,  "dataFreshness": {    "lastSyncAt": "2019-08-24T14:15:22Z",    "ageHours": 0,    "coverage": "string",    "warning": "string"  }}