Accounts

Get the Apple Ads connection status

GET
/api/v1/connection

Credential status for the workspace, plus the human hand-off under setup. There is no Apple Ads OAuth flow and no consent screen: credentials (clientId, teamId, keyId and an EC private key) can only be pasted into the dashboard by a person. An integration can detect a missing connection but can never establish one.

Required scope: admin.

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

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/connection"
{  "connected": true,  "clientId": "string",  "accountsImported": 0,  "setup": {}}