Agency Partners
Get Agency Credits
Your agency's credit balance and what client caps set aside.
GET
https://app.tryredrover.com/api/public/v1/agency/creditsScope:
credits:readNeeds a partner key; any other key or a connected AI app gets 403.
A sandbox key gets fixed figures with simulated: true.
Headers
AuthorizationstringRequiredBearerfollowed by anrr_live_API key or a connected app's access token. See Authentication.
Response
200 The agency's credits.
dataobjectRequiredShow 4 Child FieldsHide Child Fields
balancenumberRequiredCredits your agency has left
allocatednumberRequiredThe sum of every client's monthly cap
lowBalanceThresholdnumberRequiredThe balance below which credits.low fires: your auto top-up threshold, or 320 credits when you have none
simulatedbooleanRequiredTrue for sandbox keys
Errors
Every error uses the error envelope.
503Credit balances are not available yet401The Authorization header is missing, or the key is invalid or revoked403The key lacks the endpoint's scope, or cannot reach the workspace429More than 120 requests in a minute. Wait for Retry-After seconds500Something went wrong on our side
curl "https://app.tryredrover.com/api/public/v1/agency/credits" \
-H "Authorization: Bearer $REDROVER_API_KEY"{
"data": {
"balance": 4200,
"allocated": 1500,
"lowBalanceThreshold": 320,
"simulated": false
}
}