Skip to main content
GET
Get agency dashboard

Authorizations

Authorization
string
header
required

OAuth 2.1 authorization code + PKCE (S256). Tokens are tenant-bound (company_id) and scoped. Discover endpoints via /.well-known/oauth-authorization-server.

Query Parameters

statusFilter
enum<string>

Filter programs by agency-dashboard status.

Available options:
posting-as-usual,
onboarding-creator,
paused,
needs-attention
clientFilter
string

Filter by a specific client/subaccount id (must belong to this agency).

searchQuery
string

Search creators by name or handle (case-insensitive).

includeArchived
boolean

Include archived clients. Only the literal string 'true' enables this.

Response

Agency dashboard hierarchy and summary.

data
object
required

Agency dashboard hierarchy: clients -> programs -> creators, plus summary metrics.