Account

Describe the calling key

Open to every valid key, whatever its role, so an agent can find out what it may do before it tries.

get/me

Request

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

Headers

X-Workspace-Idstring

The workspace to act in, for OAuth sign-ins that reach several workspaces. Take the id from GET /workspaces. Without it the call lands in the default workspace. A workspace the caller cannot reach answers 403 with code: workspace_access_denied. An API key belongs to one workspace: send its own id or leave the header out

Response

The calling key, its role and its permissions

tokenType'api_token' | 'oauth' required
tokenIdstring nullable
tokenNamestring nullable
organizationIdstring required
issuerRolestring nullable

The workspace role of the member who created the key. The key's own permissions never exceed it

permissionsWorkspacePermission[] required
summarystring required

One sentence naming the role and what it can do

expiresAtstring date-time nullable

When the key stops working. Null means it never expires

Changes

No recorded changes to this operation across all 2 revisions of this API.