Identity

Get identity

Returns the kind, organization, workspace scope, granted scopes, and the current month's API quota snapshot for the token used to make this request. Safe to call on app boot to discover what the token can do and how much headroom is left on the monthly caps.

get/me

Request

  • Base URL: https://api.shortsync.app/v1
  • URL: https://api.shortsync.app/v1/me
  • Auth: HTTP bearer

Response

Token introspection.

kind'workspace' required

Always workspace for keys minted in v1 beta. Legacy account tokens may still authenticate on /me with kind: "account" but cannot reach any other endpoint.

key_idstring required
prefixstring required

First chars of the key, including the ss_* prefix. Safe to display.

organization_idstring required
workspace_idstring nullable

Present for workspace kind. null for account.

workspace_allowliststring[]

Present for account kind when scoped. Empty when unscoped (whole org).

scopesScope[] required
plan'free' | 'creator' | 'team' required

The organization's current plan tier. The monthly quota under quota scales with the plan; see your quota.requests.limit for the exact cap on this key.

Changes

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