Skip to content

Search Work

GET
/work/search

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.

Authorizations

Parameters

Query Parameters

q
required

Search text

string
>= 2 characters <= 200 characters

Search text

limit

Maximum hits; clamped to the server maximum

integer
default: 25 >= 1 <= 50

Maximum hits; clamped to the server maximum

conversation
Any of:
string
>= 1 characters <= 200 characters

Channel name or direct-message id to search within

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

object
data
required

Everything this credential may read that matches the query.

object
hits

Ranked hits, capped by the server maximum

Array<object>

One search hit — a message or an event, with its conversation.

object
conversation
Any of:
string
id
Any of:
string
text
Any of:
string
key
additional properties
any
query
required

The query that was run, as the server normalized it

string
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