---
title: "Search Work"
method: GET
path: "/work/search"
tags: ["Work"]
---

# Search Work

`GET /work/search`

## Request

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

Search everything this credential may read, and nothing else.

Deliberately has no storage-plane branch: "what can I find" is a question
about one caller's permissions, and there is no viewer whose membership
could scope an answer for a credential that has none.

## Query parameters

- `q` string, required: Search text
- `limit` integer: Maximum hits; clamped to the server maximum
- `conversation` string, nullable: Channel name or direct-message id to search within

## Headers

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

## Response `200`

Successful Response

- ApiResponseWorkSearchResults
  - `data` WorkSearchResults, required: Everything this credential may read that matches the query.
    - `query` string, required: The query that was run, as the server normalized it
    - `hits` WorkSearchHit[]: Ranked hits, capped by the server maximum
      - `id` string, nullable: Message or event id
      - `conversation` string, nullable: Conversation the hit belongs to
      - `text` string, nullable: Matched text
  - `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)