Skip to main content
POST
Search records

Authorizations

Authorization
string
header
required

This API uses OAuth 2.0 with the authorization code grant flow.

Body

application/json
query
string
required

Query string to search for. An empty string returns a default set of results.

Maximum string length: 256
Example:

"alan mathis"

objects
string[]
required

Specifies which objects to filter results by. At least one object must be specified. Accepts object slugs or IDs.

Minimum array length: 1

The object slug or UUID that you would like to filter by.

Example:
request_as
object
required

Specifies the context in which to perform the search. Use 'workspace' to return all search results or specify a workspace member to limit results to what one specific person in your workspace can see.

limit
number
default:25

The maximum number of results to return. Defaults to 25.

Required range: 1 <= x <= 25
Example:

25

Response

Success

Success

data
object[]
required