Account
Check your plan, credit balance, and list all your brand agents.
Authentication: Required
See your account at a glance — what plan you're on, how many credits you have left, and all the brand agents tied to your API key. This is a good first call to make when setting up an integration.
Example
Response
Key fields
| Field | What it tells you |
|---|---|
plan | Your current plan: free, starter, or pro |
creditBalance | How many credits you have left. Scans cost credits depending on mode and query count. |
creditWarning | null if you're fine. A warning message if credits are low or at zero. |
agents | Every brand agent you own, with their IDs, names, and latest scan info. Use the syntheticId values in other API calls. |
agents[].latestScore | The most recent visibility score (0–100), or null if no scan has been run yet. |
Teams
If you're part of a team, agents includes both agents you own directly and agents shared with you through team groups.