Agency Partners
Get a Client's Credits
One client's cap and what it used this period.
GET
https://app.tryredrover.com/api/public/v1/clients/{client}/creditsScope:
credits:readNeeds a partner key; any other key or a connected AI app gets 403.
Headers
AuthorizationstringRequiredBearerfollowed by anrr_live_API key or a connected app's access token. See Authentication.
Path Parameters
clientstringRequiredThe client's workspace ID, or your own reference for it. A UUID is tried as an ID first
Response
200 The client's credits.
dataobjectRequiredShow 5 Child FieldsHide Child Fields
clientIdstringRequiredThe client's workspace ID
capnumberRequiredThe client's cap, or null for none
nullable
usedThisPeriodnumberRequiredCredits the client used this period
capReachedbooleanRequiredTrue once the cap is used up
simulatedbooleanRequiredTrue for sandbox keys
Errors
Every error uses the error envelope.
404No client with this ID or reference in your agency503Credit 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/clients/crm-1042/credits" \
-H "Authorization: Bearer $REDROVER_API_KEY"{
"data": {
"clientId": "8f14e45f-ceea-4e1a-9c2b-6d7a1c3b9e21",
"cap": 600,
"usedThisPeriod": 240,
"capReached": false,
"simulated": false
}
}