account

Retrieve the current credential

Returns the organization, plan, scopes and credit balance of the API key or token making the request.

get/v1/me

Request

Base URL: http://localhost:3030
URL: http://localhost:3030/v1/me
Auth: HTTP bearer

Response

The credential.

object'credential' required

The object's type. Always credential.

organizationstring required

The organization's id.

organization_namestring required

The organization's name.

planstring required

The organization's plan, such as free.

kindstring required

Whether the credential belongs to a person or a machine. One of user or machine.

subjectstring required

The id of the API key, user or OAuth client the credential belongs to.

methodstring required

How the request was authenticated. One of session, api_key, oauth or mcp.

namestring required

The API key's name or the user's email address, for display.

scopestring[] required

The credential's scopes, such as record:read and webhook:manage. A console session also has its role's *:manage scopes.

credit_balanceinteger required

The current credit balance.

userstring nullable required

The user's id. Null for a machine credential.

Example response

{
  "organization": "0192f3a4-5b6c-7d8e-9f01-23456789abcd",
  "organization_name": "Acme Realty",
  "plan": "build",
  "kind": "machine",
  "subject": "0192f3a4-7d8e-7f90-b123-456789abcdef",
  "method": "api_key",
  "name": "Production",
  "scope": [
    "record:read"
  ],
  "user": "0192f3a4-6c7d-7e8f-a012-3456789abcde"
}

Changes

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