Get Current KeyBeta

Describe the calling API key, its workspace, plan, per-class rate limits and credit balances.

GEThttps://api.foxreach.io/api/v1/me

Requires an API key with the read scope. Use it to check which workspace a key belongs to and what it may do. The key secret and its hash are never returned.

Response#

dataobject

Result.

Show data

keyobject

The calling key.

Show key

idstring

Key identifier.

namestring

Key name.

prefixstring

First characters of the key, for identification.

scopesarray

read, write, or both.

createdAtstring

ISO 8601 timestamp.

lastUsedAtstring

ISO 8601 timestamp of this request: a key is stamped on every authenticated call.

workspaceobject

The workspace the key is confined to.

Show workspace

idstring

Workspace identifier.

namestring

Workspace name.

planobject

The workspace's effective plan.

Show plan

namestring

Plan name, for example free, starter or pro. A lapsed subscription reports free.

limitsobject

monthlyEmailLimit, dailySafetyCap, maxContacts, maxTeamMembers, maxWarmupAccounts, aiCredits, monthlyLeadFinderCredits, monthlyVerificationCredits. -1 means no cap.

rateLimitobject

Request limits for the workspace. Each class has its own bucket, shared by every key and request in the workspace.

Show rateLimit

scopestring

Always workspace.

bucketsobject

One entry per class: poll, read, write, bulk, expensive. Each is { "limitPerMinute": integer } and already includes your plan's multiplier where one applies.

creditsobject

Show credits

verificationobject

balance (integer) and expiresAt (nearest expiry, or null).

leadFinderobject

balance (integer) and expiresAt (nearest expiry, or null).

Errors#

Status	Description
`401`	Missing, invalid, revoked or expired API key
`403`	API key does not have the required scope: `read`

Rate Limit#

600 requests per minute, shared by every poll 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 (poll).
A 429 response includes a Retry-After header (seconds until the bucket resets).

For client-side patterns (Retry-After, exponential backoff, monitoring X-RateLimit-Remaining), see Rate Limiting.

Request

cURL

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

Python SDK (beta)

from foxreach import FoxReach

client = FoxReach(api_key="otr_your_key")
me = client.me()

TypeScript SDK (beta)

import { FoxReach } from "foxreach";

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

Response

JSON

{
  "data": {
    "key": {
      "id": "cmkey123",
      "name": "CRM sync",
      "prefix": "otr_ab12",
      "scopes": ["read"],
      "createdAt": "2026-10-01T08:30:00",
      "lastUsedAt": "2026-11-04T09:00:00+00:00"
    },
    "workspace": { "id": "cmws123", "name": "Acme Outreach" },
    "plan": {
      "name": "starter",
      "limits": {
        "monthlyEmailLimit": 10000,
        "dailySafetyCap": 500,
        "maxContacts": 3000,
        "maxTeamMembers": 1,
        "maxWarmupAccounts": 5,
        "aiCredits": 1000,
        "monthlyLeadFinderCredits": 50,
        "monthlyVerificationCredits": 0
      }
    },
    "rateLimit": {
      "scope": "workspace",
      "buckets": {
        "poll": { "limitPerMinute": 600 },
        "read": { "limitPerMinute": 300 },
        "write": { "limitPerMinute": 120 },
        "bulk": { "limitPerMinute": 100 },
        "expensive": { "limitPerMinute": 100 }
      }
    },
    "credits": {
      "verification": { "balance": 0, "expiresAt": null },
      "leadFinder": { "balance": 120, "expiresAt": "2027-01-15T00:00:00+00:00" }
    }
  }
}

Was this page helpful?

View as MarkdownLast updated November 4, 2026