Skip to main content
GET
Get the calling External Application's own record
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 record of the External Application making the request: its id, client id, name, status, the catalog permissions its role grants hold (allowedScopes), access-token TTL, owner, and budget posture.
This is the counterpart to Get an External Application by ID, which requires the apps:manage permission. An ordinary App does not hold it, so before this endpoint existed an App had no way to read its own configuration.

Authorization

GET /api/v2/me requires no permission. It is authorized by presenting an External Application credential — either an OAuth2 access token or the legacy companion API key — because every fact it returns is about the caller. The endpoint takes no identifier: not a path segment, not a query parameter, not a body field. The application is determined solely by the credential you present, so there is no way to request another application’s record. A plain platform API key has no External Application to describe and receives 403 Forbidden.

Common uses

  • Confirm which permissions the App’s roles hold before debugging a 403 from another route. allowedScopes is computed: the catalog permissions the App’s role grants hold, sorted. It is not narrowed by the token you present, and it cannot be written. A 403 names the missing permission in error.requiredPermission.
  • Read tokenTtlSeconds to size your token refresh interval instead of hard-coding it.
  • Check status to distinguish a deactivated application from a credential problem.
  • Read budgets to surface remaining headroom in your own UI.

Example

The response never includes the application’s client secret or callback signing secret. Both are returned exactly once, at creation and rotation respectively.

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 App's own record

data
object
required
meta
object
required