---
title: "Set Work Sidebar Preferences"
method: POST
path: "/work/sidebar-preferences"
tags: ["Work"]
---

# Set Work Sidebar Preferences

`POST /work/sidebar-preferences`

## Request

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

Store how this principal wants its own sidebar ordered.

Both halves are required and closed to ``alpha`` | ``recent``. There is no
read route here because there is none in the app: the stored value rides
the room payload (``GET /work/room``).

## Headers

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

## Request body

- WorkSidebarPreferencesRequest: How this person wants their own sidebar ordered. Both halves are required and closed-vocabulary, exactly as `normalizeSidebarSortMode` requires them (`index.ts:10838`): a partial write would leave the other half at whatever a previous client wrote and make the response a lie about the stored state.
  - `channels` 'alpha' | 'recent', required
  - `directMessages` 'alpha' | 'recent', required

## Response `200`

Successful Response

- ApiResponseWorkSidebarPreferences
  - `data` WorkSidebarPreferences, required: This principal's stored sidebar ordering.
    - `preferences` object, nullable: The ordering as stored
  - `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)