Skip to main content
The /me endpoint returns everything you need to know about your API access — your organization, plan limits, key scopes, and how much of your monthly quota you’ve consumed. Call it whenever you want to verify your key is valid, confirm which scopes are attached to it, or check how much of your quota remains before the next reset.

​
Endpoint

GET https://api.8bitedge.com/api/v1/me

​
Authentication

Send any valid bearer key in the Authorization header. No specific scope is required — any active key for an active organization will work.
If your organization is suspended you will receive a 403 account_inactive response even with a valid key. Check data.organization.status in a successful response to confirm your account is in good standing.

​
Request

curl https://api.8bitedge.com/api/v1/me \
  -H "Authorization: Bearer $BITEDGE_API_KEY"

​
Response 200

{
  "data": {
    "organization": { "id": 1, "name": "Acme Corp", "status": "active" },
    "plan": {
      "slug": "starter",
      "name": "Starter",
      "rate_limit_per_minute": 120,
      "rate_limit_per_day": 20000,
      "monthly_quota": 250000,
      "max_batch_size": 50,
      "max_page_size": 50
    },
    "api_key": { "name": "server", "last_four": "9f3a", "scopes": ["games.read"] },
    "usage": { "month": { "used": 1234, "quota": 250000, "resets_in": 1209600 } }
  }
}

​
Response fields

​
data.organization.id
int
Your organization’s unique ID.
​
data.organization.name
string
Your organization name.
​
data.organization.status
string
Account standing. Either active or suspended.
​
data.plan.slug
string
Plan identifier. One of free, starter, pro, or enterprise.
​
data.plan.rate_limit_per_minute
int
The maximum number of requests you can make in any rolling one-minute window.
​
data.plan.rate_limit_per_day
int
The maximum number of requests you can make in any single day.
​
data.plan.monthly_quota
int
Your total monthly request allowance. Returns null for unmetered Enterprise plans.
​
data.plan.max_batch_size
int
The maximum number of items you may include in a single batch request.
​
data.plan.max_page_size
int
The maximum limit value accepted by list endpoints. Requests for a larger page size are silently capped to this value — always read meta.pagination.per_page to confirm the actual page size used.
​
data.api_key.name
string
The human-readable name you assigned to this API key when it was created.
​
data.api_key.last_four
string
The last four characters of the key’s public prefix, useful for identifying which key is in use without exposing the secret.
​
data.api_key.scopes
array
The list of permission scopes assigned to this key (e.g. games.read, consoles.read, demand-intent.read). A request to an endpoint whose required scope is not present returns 403 insufficient_scope.
​
data.usage.month.used
int
The number of metered requests you have made in the current calendar month.
​
data.usage.month.quota
int
Your monthly quota for the current period, mirroring data.plan.monthly_quota.
​
data.usage.month.resets_in
int
Seconds remaining until your monthly quota counter resets. At 1 209 600 that is exactly 14 days.

​
Error responses

Statuserror.codeWhen it occurs
401unauthorizedThe Authorization header is missing, the key is invalid, revoked, or expired.
403account_inactiveYour organization or client account is suspended.