RedRover Logo

Agency Partners

List Clients

Lists your agency's clients, oldest first, including clients added after the key was made.

GET/clients
Scope: clients:read

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

A sandbox key lists sandbox clients only.

Headers

  • AuthorizationstringRequired

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

Query Parameters

  • limitinteger

    How many results to return, 1 to 100 (default 25)

    1 to 100 · default 25

  • offsetinteger

    How many results to skip (default 0)

    default 0

  • referencestring

    Only the client with this reference

Response

200 A page of clients.

  • dataobject[]Required
    Show 6 Child Fields
    • idstringRequired

      The client's workspace ID (UUID)

    • namestringRequired

      The client's name

    • referencestringRequired

      Your own ID for the client, like a CRM record

      nullable

    • contactobjectRequired

      Who you deal with at the client, for your records. Storing a contact sends no invite

      Show 2 Child Fields
      • namestringRequired

        Your contact's name

        nullable

      • emailstringRequired

        Your contact's email

        nullable

    • sandboxbooleanRequired

      True for clients made with a sandbox key

    • createdAtstringRequired

      ISO 8601 datetime

  • paginationobjectRequired
    Show 3 Child Fields
    • limitintegerRequired

      Page size used for this response

    • offsetintegerRequired

      How many results were skipped

    • hasMorebooleanRequired

      True when more results follow at a higher offset

Errors

Every error uses the error envelope.

  • 400limit or offset is not valid
  • 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?reference=crm-1042" \
  -H "Authorization: Bearer $REDROVER_API_KEY"
200 Response
{
  "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"
    }
  ],
  "pagination": {
    "limit": 25,
    "offset": 0,
    "hasMore": false
  }
}