Skip to navigation

Get embed session

Retrieves one embed session by id: its status (active, expired or revoked), its binding and the handle_id it was exchanged from, never its token. The key that minted it reads it; a workspace administrator reads any session in the organization.

Requires the embed:write scope. Rate limit: 200 requests per minute per key (the api lane).

Authentication

AuthorizationBearer

Bearer token. Use ss_live_… for live data or ss_test_… for the sandbox (test mode). See Authentication.

Path parameters

session_idstringRequired
The embed session's id.

Headers

SpreadSpace-VersionstringOptionalformat: "^\d{4}-\d{2}-\d{2}$"

Pin the API version, e.g. 2026-10-07. Omit to get the latest. See Versioning.

Response headers

X-Request-IDstringOptional
Correlation ID for this request. Quote it in support tickets.
SpreadSpace-VersionstringOptional

The API surface version the server resolved for this request. Always present, regardless of whether the client supplied the request-side SpreadSpace-Version header. Default: 2026-10-07.

RateLimit-Limitinteger

Request budget of the endpoint’s rate-limit policy per 60-second sliding window. See Rate limits.

RateLimit-Remaininginteger

Requests left in the current window. Suppressed on 429 responses produced outside the rate limiter (for example a usage throttle), where a remaining budget would be misleading.

RateLimit-Resetinteger

Seconds until a guaranteed-fresh window.

RateLimit-PolicystringOptional

The active policy in limit;w=window-seconds form.

Response

OK
session_idstring
statusenum

active (not yet past expires_at, not revoked), expired or revoked.

Allowed values:
loan_idstring
borrower_idstring
scopeslist of strings
expires_atdatetime
created_atdatetime
external_user_idstring or nullOptional

The external_user_id the mint named; null when it named none.

display_namestring or nullOptional

The display_name the mint named, as stored; null when it named none.

handle_idstring or nullOptional
revoked_atdatetime or nullOptional

Errors

400
Bad Request Error
401
Unauthorized Error
402
Payment Required Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error