Account

Identify the token and list its workspaces

Returns the account this API token belongs to and every workspace it can act on. This is the only endpoint that does not require an X-Tenant-Id header. It is where you get the values to put in one.

Each workspaces[].id is the UUID to send as X-Tenant-Id on the lookup endpoints. A token can reach more than one workspace, and each workspace has its own credits, so which one you send changes both the data you can see and the wallet you spend from.

Free, and safe to call on a schedule: it makes no lookup and deducts no credits.

credits reports BOTH wallets, because they are not interchangeable and which one you need depends on the endpoint:

  • bulk_lookup pays for the lookup endpoints, charged per resolved domain.
  • standard pays for technology lists (POST /v1/tech-lookup/lists), charged 1 flat per technology per billing period however large the list turns out to be.

These are the token holder's OWN balances. On a shared enterprise plan the wallet that actually pays belongs to the subscription owner, so for the figure a request will really draw down, read X-Credits-Remaining together with X-Credits-Type off any workspace-scoped response, or call GET /v1/tech-lookup/credits with an X-Tenant-Id.

An empty workspaces array means the token is valid but the account is not a member of any workspace, so no lookup will succeed yet.

Rate limit: 60 requests per minute, counted per API token. Going over returns 429 with error_code: rate_limited and a Retry-After header in seconds. A 429 costs no credits. Traffic is also subject to a higher shared ceiling per network address, applied before authentication.

get/v1/me

Request

  • Base URL: https://api.stackscan.com/api
  • URL: https://api.stackscan.com/api/v1/me
  • Auth: HTTP bearer

Response

The token holder and the workspaces it can reach.

successboolean required

Example response

{
  "success": true,
  "user": {
    "id": 42,
    "name": "Dana Reyes",
    "email": "dana@acme.com"
  },
  "workspaces": [
    {
      "id": "9f1c2d84-7b3e-4a10-9c55-1e7a6b0f2d31",
      "name": "Acme Inc"
    },
    {
      "id": "2b7e5a09-4c61-4f88-b0d2-33ac91e4f7aa",
      "name": "Acme Labs"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.