Skip to main content
GET
Get the calling credential's effective permissions and the operations they satisfy
The reference panel describes the current v3 operation. The notes below describe its v2 compatibility API. Follow the v3 request schema for current calls: v3 can move identifiers from the body or query into the URL. Keep the v2 method, path, and payload together when using the compatibility API.

v2 compatibility notes

Returns the permissions this request holds and, for each documented operation that requires a permission, whether it holds them. Use it to check what your credential can call before you call it, or to tell a missing grant apart from a refusal at a particular resource. It is the same computation as GET /api/v2/actor, without the actor and owner block: call /actor when you also need to know who the credential is.

Authorization

GET /api/v2/me/permissions requires no permission. Any Platform API credential can call it: a platform API key, a Personal key, or an External App’s access token. Every fact it returns is about the caller. The endpoint takes no identifier. A request that sends any query parameter or a body is refused with 400 and code bad_request, so there is no way to ask about another key, app or person. A missing, revoked or expired credential receives the usual 401.

Response

Each entry in operations has:
permissionSatisfied is advisory. It does not mean the operation will succeed on a particular resource: the operation checks the target when you call it. Do not cache this response as an authorization decision.
Which kinds of credential each operation admits is listed in the credential kinds reference.

Example

Authorizations

Authorization
string
header
required

An External App: the JWT it obtains from POST /oauth/token with OAuth2 client_credentials. Pass as Authorization: Bearer <jwt>. An app's static companion key also authenticates as the app, but is deprecated and is not protected by Idempotency-Key.

Response

The calling credential's effective permissions

data
object
required
meta
object
required