Skip to main content
GET
Get website session

Authorizations

Authorization
string
header
required

Access token issued by gs.service.id. Its access_identity claim carries team_sid, actor_sid and actor_type, and that team scope is authoritative.

Team-SID
string
header
required

Team scope for tokens that do not carry one. Ignored when the token already names a team.

Path Parameters

sid
string
required

The sg_ws_* sid of the row to read.

Required string length: 18
Pattern: ^sg_ws_

Query Parameters

include[]
enum<string>[]

Relations to attach to the row; omit for the bare row.

visitor: the browser's row; person and company: the owner's sid (the cards are owed).

Available options:
visitor,
person,
company

Response

get success envelope.

success
enum<boolean>
required
Available options:
true
operation
enum<string>
required
Available options:
get
item
object
required
included
object
required
includes
string[]
required
meta
object
required