---
title: "Get Work Room"
method: GET
path: "/work/room"
tags: ["Work"]
---

# Get Work Room

`GET /work/room`

## Request

- Base URL: `https://be.graph8.com/api/v1`
- URL: `https://be.graph8.com/api/v1/work/room`
- Auth: HTTP bearer

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.

## Headers

- `Authorization` string, nullable
- `X-Target-Org-Id` string, nullable

## Response `200`

Successful Response

- ApiResponseWorkRoom
  - `data` WorkRoom, required: The canonical Work room, scoped and bounded for whoever asked for it.
    - `room` object, nullable: Channels, direct messages, messages, events and per-viewer state the caller may read
    - `counts` object, nullable: Per-collection counts of what the caller can see
    - `truncation` object, nullable: What was left out of the bounded read, and the cursors to resume from
    - `members` object[], nullable: Organization member directory, for turning an actor id into a name
    - `agents` object[], nullable: Agent roster available in this workspace
  - `pagination` PaginationMeta
    - `page` integer, required: Current page number (1-indexed)
    - `limit` integer, required: Items per page
    - `total` integer, required: Total number of items
    - `has_next` boolean, required: Whether there are more pages
    - `next_cursor` string, nullable: Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers.
    - `total_available` integer, nullable: Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search.
    - `total_is_lower_bound` boolean, nullable: Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search.
    - `notes` string[], nullable: Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order.

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/graph8/apis/graph8-developer-api.md) · [All operations](https://skmtc.dev/graph8/apis/graph8-developer-api/llms.txt) · [OpenAPI document](https://skmtc.dev/graph8/apis/graph8-developer-api/revisions/2e7cfa0ca921?raw)