Skip to main content

List Staff Views

GET 

/api/admin/portal/accounts/:customer/view-as-sessions

Lists the account's 20 most recent staff views, newest first — the audit trail of who viewed the portal as which buyer, from where, and when it started and ended.

Not yet available to API tokens

This endpoint currently requires session authentication; Personal Access Token scope support is in progress.

Requires the portal.manage permission.

Session fields:

  • id (integer): session id, used to revoke it.
  • status (string): pending (link not yet opened), active, expired, exited (the viewer clicked Exit) or revoked.
  • staff_user_id (integer), staff_name (string|null): who started the view.
  • customer_id (integer): the portal account.
  • buyer (object): id, name and email of the buyer viewed as.
  • ip_address (string|null): IP the view was started from.
  • created_at, started_at, expires_at, ended_at (string|null): ISO-8601 timestamps.
  • end_reason (string|null): exited or revoked.

Request​

Responses​

OK

Response Headers
    Content-Type