Show the key, its workspace, plan and credits
GET/me
- Scope:
- read
- Rate class:
- light
- Operation id:
- get_me
Returns what the API key you send acts as: the workspace and your role in it, the plan and the flags that matter to API users (exports, team seats), this month's credits and what a page costs, the key's own scopes, daily credit cap and expiry (never its secret), and which parts of the API are switched on. Call it first to check a key and a budget. It is free, and needs the read scope.
Answer 200
OK. The body is a Me.
| Field | Type | Description |
|---|---|---|
| api_version | string | The API's major version. |
| workspace | object | |
| workspace.id | integer | The workspace's id (the id of its owner's account). |
| workspace.name | string | The workspace's name. |
| role | string | The key creator's role in the workspace today: owner, admin, member or viewer. |
| plan | object | |
| plan.name | string | The plan's stable name (free, starter, business, business_plus, enterprise...). |
| plan.display_name | string | The plan's name as the dashboard shows it. |
| plan.has_export | boolean | True when CSV, Excel and PDF exports (and live feeds) are included. |
| plan.team_seats | integer or null | Team members besides the owner: 0 = owner only, null = unlimited. |
| credits | object | |
| credits.period | string | The month the numbers are for (YYYY-MM, UTC). |
| credits.used | number | Credits spent this month. |
| credits.limit | number or null | Credits the plan gives this month, bonus included; null = unlimited. |
| credits.remaining | number or null | Credits left this month; null = unlimited. |
| credits.bonus | number | Bonus credits added to this month. |
| credits.unlimited | boolean | True when the plan has no credit limit. |
| credits.costs | object | |
| credits.costs.scan_fast | number | Credits per page of a fast crawl. |
| credits.costs.scan_detailed | number | Credits per page of a detailed crawl. |
| credits.costs.scan_js_rendering | number | Credits per page rendered with JavaScript. |
| credits.costs.scan_fast_owned | number | Per page of a fast crawl of a site you own (verified). |
| credits.costs.scan_detailed_owned | number | Per page of a detailed crawl of a site you own. |
| credits.costs.scan_js_rendering_owned | number | Per rendered page of a site you own. |
| key | object | |
| key.name | string | The name given to the key. |
| key.prefix | string | The first characters of the key (pbk_xxxxxxxx): enough to recognise it. The secret is never shown. |
| key.scopes | array of string | What the key may do: read, crawl (includes read), webhooks. |
| key.daily_credit_cap | integer or null | Credits the crawls this key starts may cost per UTC day. -1 = the key was made with no cap; null = a key made before the REST API existed (the crawls it starts may check at most 500 pages each). |
| key.expires_at | string or null | When the key stops working (ISO 8601 UTC); null = never. |
| key.last_used_at | string or null | When the key was last used (ISO 8601 UTC, to the minute); null = never. |
| api | object | |
| api.crawl_enabled | boolean | True when POST /crawls (start and cancel a crawl) is available. |
| api.webhooks_v2 | boolean | True when signed webhook endpoints can be managed through the API. |
Example 200 answer of Show the key, its workspace, plan and credits
{
"api_version": "v1",
"workspace": {
"id": 12,
"name": "Acme's workspace"
},
"role": "owner",
"plan": {
"name": "business",
"display_name": "Business",
"has_export": true,
"team_seats": 10
},
"credits": {
"period": "2026-10",
"used": 1240.5,
"limit": 10000,
"remaining": 8759.5,
"bonus": 0,
"unlimited": false,
"costs": {
"scan_fast": 1,
"scan_detailed": 2,
"scan_js_rendering": 4,
"scan_fast_owned": 0.5,
"scan_detailed_owned": 1,
"scan_js_rendering_owned": 2
}
},
"key": {
"name": "CI",
"prefix": "pbk_k3x9a7bq",
"scopes": [
"read",
"crawl"
],
"daily_credit_cap": 2000,
"expires_at": "2027-01-15T09:00:00Z",
"last_used_at": "2026-10-31T08:41:00Z"
},
"api": {
"crawl_enabled": true,
"webhooks_v2": false
}
}