リファレンスHTTP APISessions

Who sees the session

GET
/v1/sessions/{id}/share

Readable by whoever sees the session. A session never re-shared reads workspace at revision 0. audience_limited is true when workspace does not reach every member: the session is an agent's, the agent is not held by the 'Unassigned agents' team of migration 0243, and the workspace's agent_outsider_session_visibility is managing_team, so only those inside the agent see it (PATCH /v1/workspaces/{id}/agent-access).

Scope: sessions:read (API key or cookie session).

Authorization

headerAuthorizationBearer <token>

For servers and scripts: an API key sent as an HTTP bearer token, Bearer <key>. It holds exactly the scopes it was issued with; a key issued before scopes existed holds none. It never needs the CSRF header, and it cannot manage agents, members, teams or API keys. Issue one in the web console under Settings → API keys; each operation names the scope it needs.

Scope: sessions:read

Path Parameters

id*string

The session's id.

Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Formatuuid

Response Body

Success

application/json
  1. response
session_id*string
Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Formatuuid
scope*string
Value in"private""people""team""workspace"
user_ids*array<>
team_ids*array<>
revision*integer
Range0 <= value <= 2147483647
updated_by*|null
updated_at*|null
audience_limited*boolean

True when workspace reaches only those inside the session's agent, whatever scope is now: the workspace's agent_outsider_session_visibility is managing_team and the agent's managing team is not the holding team that took agents which had none (those stay visible to every member until moved to a real team). Owners, admins, the agent's admins and its managing team's members are inside. people and team still reach whom they name.

Example Request
curl -X GET 'https://example.com/v1/sessions/497f6eca-6276-4993-bfeb-53cbbbba6f08/share'
Example Response
{  "session_id": "1ffd059c-17ea-40a8-8aef-70fd0307db82",  "scope": "private",  "user_ids": [    "2d98503d-4ab4-41bd-8fc6-78cc006fd2db"  ],  "team_ids": [    "a6a20ef3-202d-4e2c-be30-1ec5fea948be"  ],  "revision": 0,  "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",  "updated_at": "2019-08-24T14:15:22Z",  "audience_limited": true}