Get current workspace identity

GET

/v1/me

• Production

Returns the workspace identity associated with the bearer key. Useful as a connectivity smoke-test. No specific scope is required - any valid key may call this endpoint.

Authorizations

• bearerAuth

Responses

200

Authenticated workspace identity.

Workspace identity returned by GET /v1/me.

object

id

Internal user id.

integer

email

Workspace email address.

string format: email

name

Display name (maps to FullName on the user record).

string

nullable

createdAt

Account creation timestamp (UTC).

string format: date-time

apiKey

Metadata about the API key used in this request.

object

keyId

12-character key identifier.

string

scopes

Scopes granted to this key.

Array<string>

workspace

Which shared pool this request acted on, and which ids the key may switch to with X-Workspace-Id. Without this an integration has no way to discover that a team scope exists.

object

activeId

Workspace this request resolved to. Null means personal scope.

integer

nullable

role

The caller’s role in the active workspace. A Viewer cannot write.

string

Allowed values: Owner Admin Member Viewer

canWrite

boolean

header

Name of the header that selects a workspace (“X-Workspace-Id”).

string

available

Every workspace this key may address.

Array<object>

object

id

integer

name

string

slug

string

role

string

Example

{
  "id": 42,
  "email": "jane@example.com",
  "name": "Acme Inc.",
  "createdAt": "2024-01-15T09:00:00Z",
  "apiKey": {
    "keyId": "abc123def456",
    "scopes": [
      "contacts:read",
      "telegram:send"
    ]
  }
}

401

Missing or invalid bearer token.

Standard error envelope for all v1 error responses.

object

error

Machine-readable error code.

string

Allowed values: bad_request not_found conflict unauthorized forbidden payment_required provider_rejected rate_limited internal_error

message

Human-readable explanation of the error.

string

details

Optional structured context (field-level validation errors, etc.).

nullable

Example

{
  "error": "unauthorized",
  "message": "Invalid bearer principal"
}

404

The requested resource does not exist or is not owned by the caller.

Standard error envelope for all v1 error responses.

object

error

Machine-readable error code.

string

Allowed values: bad_request not_found conflict unauthorized forbidden payment_required provider_rejected rate_limited internal_error

message

Human-readable explanation of the error.

string

details

Optional structured context (field-level validation errors, etc.).

nullable

Example

{
  "error": "not_found",
  "message": "contact not found"
}