Skip to content

Get Work Room

GET
/work/room

The whole Work room this credential may read, in one call.

Channels, conversations, recent messages and events, the member directory and the agent roster — narrowed to the caller’s own audience and bounded to the recent end of history. truncation names what was left out and carries the cursor to resume each conversation from at GET /work/conversations/{conversation_id}/messages.

For an organisation credential that audience is the built-in channels; see the module docstring for why, and for what it is not.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

object
data
required

The canonical Work room, scoped and bounded for whoever asked for it.

object
agents
Any of:
Array<object>
object
key
additional properties
any
counts
Any of:
object
key
additional properties
any
members
Any of:
Array<object>
object
key
additional properties
any
room
Any of:
object
key
additional properties
any
truncation
Any of:
object
key
additional properties
any
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string