Compass DocsBy Mesa
Open App

👤 Identity (GET /v1/me)

Returns the account, plan, live credit balance, and pricing behind the API key you authenticate with. Use it to confirm a key works and to read your balance before you spend. It is free.

Request

GET /api/v1/me
Base URL https://compass.mesa.so
Auth Authorization: Bearer ck_live_…
Scope read:metadata
Cost 0 credits (free)
Version every response carries Compass-API-Version (currently 1.1.1) 
curl https://compass.mesa.so/api/v1/me \
  -H "Authorization: Bearer ck_live_your_key_here"

Response 200

{
  "apiVersion": "1.1.1",
  "id": "clx0...",
  "name": "Ada Lovelace",
  "email": "ada@example.com",
  "tier": "starter",
  "organization": "Example Labs",
  "creditsBalance": 2850,
  "apiKey": {
    "label": "agent",
    "prefix": "ck_live_AbCdEf",
    "scopes": ["read:metadata", "read:contacts"],
    "environment": "live"
  },
  "pricing": {
    "currency": "credits",
    "basicCallCredits": 5,
    "privateCallCredits": 10,
    "note": "Data calls cost 5 credits. Revealing a contact's private channels costs 10 credits the first time (a permanent unlock); later calls on that contact cost 5. Credits come from your subscription."
  },
  "meta": {
    "creditsCharged": 0,
    "creditsBalance": 2850
  }
}

Fields

Field Type Description
apiVersion string The API build you are talking to. Also sent as the Compass-API-Version header.
id string The account the key belongs to.
name string The account holder's name.
email string The account holder's email.
tier string The plan: free, starter, pro, team, or enterprise.
organization string The workspace name, or Compass if none is set.
creditsBalance number Credits available right now. Data calls cost 5; a private reveal costs 10.
apiKey.label string The label you gave the key.
apiKey.prefix string The key's display prefix, such as ck_live_AbCdEf.
apiKey.scopes string[] What the key may read: read:metadata and read:contacts.
apiKey.environment string The key's environment, such as live.
pricing object The credit cost of a basic call (basicCallCredits) and a private reveal (privateCallCredits).
meta.creditsCharged number Credits this call charged (0 for /v1/me).
meta.creditsBalance number Your balance after this call.

Errors

Code Reason
401 The key is missing, malformed, or revoked.
429 You hit the rate limit. Back off and retry.

Data calls (not /v1/me) can also return 402 when you are out of credits. See Errors & Status Codes.