Agency Partners
Get a Client
Reads one client by workspace ID or by your reference.
GET
https://app.tryredrover.com/api/public/v1/clients/{client}Scope:
clients: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.
dataobjectRequiredShow 6 Child FieldsHide Child Fields
idstringRequiredThe client's workspace ID (UUID)
namestringRequiredThe client's name
referencestringRequiredYour own ID for the client, like a CRM record
nullable
contactobjectRequiredWho you deal with at the client, for your records. Storing a contact sends no invite
Show 2 Child FieldsHide Child Fields
namestringRequiredYour contact's name
nullable
emailstringRequiredYour contact's email
nullable
sandboxbooleanRequiredTrue for clients made with a sandbox key
createdAtstringRequiredISO 8601 datetime
Errors
Every error uses the error envelope.
404No client with this ID or reference in your agency401The 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" \
-H "Authorization: Bearer $REDROVER_API_KEY"{
"data": {
"id": "8f14e45f-ceea-4e1a-9c2b-6d7a1c3b9e21",
"name": "Acme Analytics",
"reference": "crm-1042",
"contact": {
"name": "Jane Smith",
"email": "jane@acme.com"
},
"sandbox": false,
"createdAt": "2026-11-16T10:00:00Z"
}
}