Skip to main content
GET
/
api
/
v2
/
me
Get current user
curl --request GET \
  --url https://api.example.com/api/v2/me
The canonical “what can I do right now” endpoint. Verifies your API key AND surfaces every budget the UI needs to render paywall hints.

​
Request

curl https://www.catchthegoodones.com/api/v2/me \
  -H "Authorization: Bearer ctgo_your_api_key_here"

​
Response

{
  "name": "Jane Smith",
  "email": "jane@example.com",
  "subscriptionStatus": "active",
  "isFreeTier": false,
  "accounts": [
    {
      "accountId": 7,
      "xHandle": "yongfook",
      "tier": "starter",
      "monthlyRetest": {
        "used": 1,
        "budget": 12,
        "remaining": 11,
        "billingPeriodStart": "2026-05-15T00:00:00Z"
      },
      "dailySync": { "used": 0, "cap": 1, "remaining": 1 }
    }
  ],
  "credits": {
    "balance": 47,
    "lowBalanceThreshold": 10,
    "isLow": false,
    "autoTopupEnabled": false
  },
  "totals": {
    "monthlyRetestRemaining": 11,
    "dailySyncRemaining": 1
  }
}

​
Response fields

FieldTypeDescription
namestringUser’s display name
emailstringUser’s email
subscriptionStatusenumactive, trialing, free_user, past_due, etc.
isFreeTierbooleanConvenience flag
accounts[]arrayPer-account budgets
accounts[].monthlyRetestobjectRe-test budget for this account, this billing period
accounts[].dailySyncobjectDaily sync slot count for this account
creditsobjectTeam credit balance for enrichment
totalsobjectSum-across-accounts rollup

​
Auth

Bearer API key or session cookie.