Skip to content
Open app

Get current workspace identity

GET
/v1/me

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.

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>
Example
{
"id": 42,
"email": "[email protected]",
"name": "Acme Inc.",
"createdAt": "2024-01-15T09:00:00Z",
"apiKey": {
"keyId": "abc123def456",
"scopes": [
"contacts:read",
"telegram:send"
]
}
}

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 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"
}

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 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"
}