RedRover Logo

Agency Partners

Get a Client's Credits

One client's cap and what it used this period.

GET/clients/{client}/credits
Scope: credits:read

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

Headers

  • AuthorizationstringRequired

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

Path Parameters

  • clientstringRequired

    The client's workspace ID, or your own reference for it. A UUID is tried as an ID first

Response

200 The client's credits.

  • dataobjectRequired
    Show 5 Child Fields
    • clientIdstringRequired

      The client's workspace ID

    • capnumberRequired

      The client's cap, or null for none

      nullable

    • usedThisPeriodnumberRequired

      Credits the client used this period

    • capReachedbooleanRequired

      True once the cap is used up

    • simulatedbooleanRequired

      True for sandbox keys

Errors

Every error uses the error envelope.

  • 404No client with this ID or reference in your agency
  • 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/clients/crm-1042/credits" \
  -H "Authorization: Bearer $REDROVER_API_KEY"
200 Response
{
  "data": {
    "clientId": "8f14e45f-ceea-4e1a-9c2b-6d7a1c3b9e21",
    "cap": 600,
    "usedThisPeriod": 240,
    "capReached": false,
    "simulated": false
  }
}