API referenceAd Account Requests

List ad account requests

Lists the organization's ad account requests, newest first. Cancelled requests are not listed. Each request carries its stage (1 request sent, 2 business verified, 3 account being created, 4 shared into your Business Manager, 5 connected in Koast, 6 funds added), the ad accounts it produced (act_…) and every top-up with its payment status. Requests are made in the Koast app, where the business documents are uploaded, and Koast reviews each one before sending it on: awaitingReview is true until then. A key limited to specific brands is refused with 403 brand_not_allowed: requests belong to the whole organization.

GET
/v1/ad-account-requests
bearerAuth
headerAuthorizationBearer <token>

An organization API key (koast_sk_…) with the API surface enabled, or an OAuth access token issued by Koast (koast_at_…) whose audience covers this API. REST access requires an active Agency plan.

cursor?string

Opaque cursor from the previous page's nextCursor. Omit for the first page.

limit?integer

Page size.

Range1 <= value <= 100
Default50

Response Body

List ad account requests

application/json
  1. response
data*array<>
nextCursor*|

Pass as cursor to read the next page. Null when there is no next page.

curl -X GET "https://example.com/v1/ad-account-requests" \  -H "Authorization: Bearer koast_sk_..."
{  "data": [    {      "id": "string",      "reference": "string",      "status": "QUEUED",      "accountName": "string",      "count": -9007199254740991,      "currency": "string",      "createdAt": "string",      "brandId": -9007199254740991,      "adAccountIds": [        "string"      ],      "rejectionReason": "string",      "stage": 0,      "awaitingReview": true,      "accounts": [        {          "adAccountId": "string",          "name": "string",          "status": "string",          "replacement": {            "status": "requested",            "requestedAt": "string",            "reason": "string",            "newAdAccountId": "string",            "movedCents": -9007199254740991,            "completedAt": "string"          },          "replaces": "string"        }      ],      "topUps": [        {          "id": "string",          "adAccountId": "string",          "budgetCents": -9007199254740991,          "commissionCents": -9007199254740991,          "locationFeeCents": -9007199254740991,          "netCents": -9007199254740991,          "amountCents": -9007199254740991,          "currency": "string",          "status": "AWAITING_PAYMENT",          "paymentMethod": "card",          "createdAt": "string",          "paidAt": "string",          "creditedAt": "string"        }      ]    }  ],  "nextCursor": "string"}

Required scope: read. CLI: koast list-ad-account-requests, see Ad Account Requests commands. Authentication, headers, errors and pagination work the same on every operation. See Conventions.