List Agency Clients

List the workspaces owned by the agency owner, with health and usage.

GEThttps://api.foxreach.io/api/v1/agency/clients

Requires an API key with the read scope.

Only API keys of an Agency workspace can call this endpoint (403 agency_required otherwise). The call always runs in the key's own workspace; X-Workspace-Id is ignored.

The list is not paginated: an Agency plan allows at most 30 workspaces. It includes the agency workspace itself.

Response#

dataarray

Show Client workspace

idstring

Workspace id. Pass it as X-Workspace-Id to act as the client.

namestring

Workspace name.

slugstring

URL slug.

isPersonalboolean

true for the owner's personal workspace.

contactsinteger

Contacts stored.

maxContactsinteger

Contact limit on the Agency plan.

sentThisMonthinteger

Emails sent this month.

monthlyLimitinteger

Monthly send limit.

totalCampaignsinteger

Campaigns in the workspace.

activeCampaignsinteger

Campaigns currently sending.

totalAccountsinteger

Email accounts connected.

connectedAccountsinteger

Accounts connected and active.

errorAccountsinteger

Accounts in an error state.

totalRepliesinteger

Real replies (bounces, warmup and unrelated mail excluded).

replyRatenumber

Replies as a percentage of emails sent this month.

verificationCreditsinteger

Unexpired email verification credits.

statusstring

error, active, idle or setup.

createdAtstring

ISO 8601 timestamp.

Errors#

Status	Description
`401`	Missing, invalid, revoked or expired API key
`403`	API key does not have the required scope: `read`
`403`	`agency_required`: the key's workspace does not hold an Agency plan

Rate Limit#

300 requests per minute, shared by every read call in your workspace. Fixed 60-second window.
Every response includes X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset (unix epoch seconds) and X-RateLimit-Bucket (read).
A 429 response includes a Retry-After header (seconds until the bucket resets).

For client-side patterns, see Rate Limiting.

Request

cURL

curl "https://api.foxreach.io/api/v1/agency/clients" \
  -H "X-API-Key: otr_your_key"

Python SDK

from foxreach import FoxReach

client = FoxReach(api_key="otr_your_key")
clients = client.agency.list_clients()

TypeScript SDK

import { FoxReach } from "foxreach";

const client = new FoxReach({ apiKey: "otr_your_key" });
const clients = await client.agency.listClients();

Response

JSON

{
  "data": [
    {
      "id": "ws_abc123",
      "name": "Acme Co",
      "slug": "acme-co",
      "isPersonal": false,
      "contacts": 1200,
      "maxContacts": 100000,
      "sentThisMonth": 3400,
      "monthlyLimit": 500000,
      "totalCampaigns": 2,
      "activeCampaigns": 1,
      "totalAccounts": 3,
      "connectedAccounts": 3,
      "errorAccounts": 0,
      "totalReplies": 41,
      "replyRate": 1.2,
      "verificationCredits": 500,
      "status": "active",
      "createdAt": "2026-10-01T09:00:00+00:00"
    }
  ]
}

Was this page helpful?

View as MarkdownLast updated November 4, 2026