See an org as one of its members

POST

/staff/orgs/{orgId}/impersonate

curl --request POST \
  --url https://api.sloose.com/staff/orgs/org_9f3c/impersonate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "userId": "example", "reason": "example", "write": true, "confirm": "example" }'

• Production
• Staging

Backoffice route, staff session only — the shared ADMIN_TOKEN is refused with 403 SESSION_REQUIRED. Mints a session for a member of the org that lasts an hour and does not slide. Read-only by default: every request that is not a GET is refused with 403 IMPERSONATION_READ_ONLY, except POST /auth/session/refresh and POST /auth/impersonation/end.

Pass write: true for a view that acts as the member for real — every row it writes is theirs, and the org cannot tell from the data that it was not. That variant needs a reason and confirm set to the org’s own name, and is refused rather than downgraded if either is missing.

The widget shows who is looking, and says so more loudly when the view can write. Staff session only — the admin token cannot look as somebody, since nobody would be on the record. Written down as impersonate.start against the member, with write in the detail.

Authorizations

• sessionAuth

Parameters

Path Parameters

orgId

required

The org

string

Example

org_9f3c

The org

Request Body

Media typeapplication/json

object

userId

The member to see the org as. Defaults to its most senior member.

string

reason

Why, for the record.

string

<= 500 characters

write

Ask for a view that may write. reason and confirm are then required, and the request is refused — never quietly downgraded to read-only — if either is missing. Omit for a read-only view.

boolean

confirm

The org’s own name, typed out. Required when write is true.

string

Example^generated

{
  "userId": "example",
  "reason": "example",
  "write": true,
  "confirm": "example"
}

Responses

201

The session, read-only unless write was asked for, and where to open it.

Media typeapplication/json

object

session

required

object

token

required

A session token for the member. Read-only unless write on this response is true.

string

orgId

required

string

userId

required

string

role

required

string

Allowed values: owner admin builder operator

dc

required

string

exp

required

Expiry, seconds since the epoch. Does not slide.

number

write

required

Whether this view may write, or only read.

boolean

member

required

object

email

required

string

displayName

required

string | null

expiresAt

required

string

widgetUrl

required

The widget, outside the CRM, with the session in the fragment — open it in a new tab.

string

Example

{
  "session": {
    "role": "owner"
  }
}

400

The request body did not match the schema. issues carries the Zod issue list.

Media typeapplication/json

The error envelope every non-2xx answer uses.

object

error

required

Human-readable explanation.

string

code

Machine-readable reason. Absent on a few legacy 400s.

string

key

additional properties

Example^generated

{
  "error": "example",
  "code": "example"
}

401

A bearer that is neither the token nor a live session (code: AUTH_REQUIRED).

Media typeapplication/json

The error envelope every non-2xx answer uses.

object

error

required

Human-readable explanation.

string

code

Machine-readable reason. Absent on a few legacy 400s.

string

key

additional properties

Example^generated

{
  "error": "example",
  "code": "example"
}

403

A customer’s session, an API token, or no bearer at all — not staff, and not the ADMIN_TOKEN (code: ADMIN_REQUIRED).

Media typeapplication/json

The error envelope every non-2xx answer uses.

object

error

required

Human-readable explanation.

string

code

Machine-readable reason. Absent on a few legacy 400s.

string

key

additional properties

Example^generated

{
  "error": "example",
  "code": "example"
}

404

No such member of this org, or it is not visible to this session.

Media typeapplication/json

The error envelope every non-2xx answer uses.

object

error

required

Human-readable explanation.

string

code

Machine-readable reason. Absent on a few legacy 400s.

string

key

additional properties

Example^generated

{
  "error": "example",
  "code": "example"
}