RedRover Logo

Agency Partners

Get Agency Credits

Your agency's credit balance and what client caps set aside.

GET/agency/credits
Scope: credits:read

Needs a partner key; any other key or a connected AI app gets 403.

A sandbox key gets fixed figures with simulated: true.

Headers

  • AuthorizationstringRequired

    Bearer followed by an rr_live_ API key or a connected app's access token. See Authentication.

Response

200 The agency's credits.

  • dataobjectRequired
    Show 4 Child Fields
    • balancenumberRequired

      Credits your agency has left

    • allocatednumberRequired

      The sum of every client's monthly cap

    • lowBalanceThresholdnumberRequired

      The balance below which credits.low fires: your auto top-up threshold, or 320 credits when you have none

    • simulatedbooleanRequired

      True for sandbox keys

Errors

Every error uses the error envelope.

  • 503Credit balances are not available yet
  • 401The Authorization header is missing, or the key is invalid or revoked
  • 403The key lacks the endpoint's scope, or cannot reach the workspace
  • 429More than 120 requests in a minute. Wait for Retry-After seconds
  • 500Something went wrong on our side
curl "https://app.tryredrover.com/api/public/v1/agency/credits" \
  -H "Authorization: Bearer $REDROVER_API_KEY"
200 Response
{
  "data": {
    "balance": 4200,
    "allocated": 1500,
    "lowBalanceThreshold": 320,
    "simulated": false
  }
}