Skip to content

Account

The account endpoints report who you are, what plan you are on, how many credits remain, and what every past request did. Both are GETs and consume no credits.

MethodPathWhat it returns
GET/v1/meAccount, plan, and credit balance
GET/v1/usagePer-request usage records, newest first
Terminal window
curl "https://api.rolesapi.com/v1/me" \
-H "Authorization: Bearer rk_live_your_key"

GET /v1/me

No parameters.

{
"data": {
"account": {
"id": "acct_01hqrs",
"email": "dev@example.com",
"created_at": "2026-05-12T08:00:00Z"
},
"plan": {
"id": "monthly",
"name": "Monthly",
"credits_per_cycle": 1000,
"rpm": 200
},
"credits": {
"remaining": 640
}
},
"request_id": "req_11a8d5c2"
}
FieldMeaning
accountYour account id, email, and creation time.
planCurrent plan: free, monthly, or annual, with its credit allotment and requests-per-minute. See Rate limits.
credits.remainingCredits available right now, including any top-ups.

GET /v1/me is a good health check: it verifies the key, and lets a worker refuse to start a large batch when credits.remaining is too low to finish it.

GET /v1/usage

One record per API request, newest first.

ParameterInTypeDescription
sincequerystringISO 8601 timestamp; only records at or after this time.
limitqueryintegerPage size. Combine with offset — see Pagination.
Terminal window
curl "https://api.rolesapi.com/v1/usage?since=2026-07-01T00:00:00Z&limit=50" \
-H "Authorization: Bearer rk_live_your_key"
{
"data": [
{
"id": "usg_01hjkl",
"created_at": "2026-07-01T09:15:22Z",
"method": "GET",
"path": "/v1/roles/a1b2c3d4e5f60718",
"status": 200,
"credits": 1,
"request_id": "req_8f3a2b1c",
"latency_ms": 842
}
],
"meta": { "total": 137, "count": 1, "limit": 1, "offset": 0, "has_more": true },
"request_id": "req_cd02e977"
}
FieldTypeMeaning
idstringUsage record id.
created_atstringWhen the request was made.
methodstringHTTP method.
pathstringThe path called.
statusintegerHTTP status returned.
creditsintegerCredits charged (0 for errors and control-plane calls).
request_idstringMatches the request_id in that response — join usage to your logs with it.
latency_msintegerServer-side processing time for that request.

What is usage good for?

  • Reconciliation — sum credits over a window to verify billing against your own metering.
  • Debugging — find the exact failing request by request_id, then quote it to support (nikhil@landkit.pro).
  • Rotation checks — after deploying a new key, confirm the old one has gone quiet before revoking it. See Authentication.
RolesAPI is not affiliated with, endorsed by, or sponsored by Indeed, Inc. Indeed is a registered trademark of Indeed, Inc. RolesAPI provides access to publicly available data via a stable REST API.