sessions module route (requires sessions:workspace:read)

GET

/v1/m/sessions/workspaces/{ref}

curl --request GET \
  --url https://example.com/v1/m/sessions/workspaces/example \
  --header 'Authorization: Bearer <token>'

• this engine

Returns one session workspace by reference.

Authorizations

• bearerAuth
• browserSession

Parameters

Path Parameters

ref

required

string

Path parameter ref.

Header Parameters

X-Olivares-Tenant

string format: uuid

Target tenant id; required when the principal can act in more than one tenant.

Responses

200

Registered folder, exact setup text, last approval as evidence, and setup_approved, true only while that approval covers the current text

Media type application/json

object

setup_approval

object

actor

required

string

at

required

string format: date-time

sha256

required

string

/^[0-9a-f]{64}$/

setup_approved

boolean

setup_command

string

setup_command_sha256

string

Example ^generated

{
  "setup_approval": {
    "actor": "example",
    "at": "2026-04-15T12:00:00Z",
    "sha256": "example"
  },
  "setup_approved": true,
  "setup_command": "example",
  "setup_command_sha256": "example"
}

400

Bad request

Media type application/json

object

Example ^generated

{}

401

Unauthenticated

Media type application/json

object

Example ^generated

{}

403

Forbidden

Media type application/json

object

Example ^generated

{}

404

Not found

Media type application/json

object

Example ^generated

{}

409

Conflict / setup required

Media type application/json

object

Example ^generated

{}

429

Rate limited

Media type application/json

object

Example ^generated

{}