Skip to main content
GET
cURL

Authorizations

X-Session-Token
string
header
required

Session token for authentication.

Query Parameters

include
enum<string>[]

A comma separated list of related resources to include.

Available options:
scheme,
work_order,
operation,
organisation
filter
string
default:""

Filters the response data based on the value provided.

Available filters:

  • term: Required, with contains. Finds resources whose name contains the value, such as contains(term,cabling). Without it, the search returns nothing.
  • resource: The kinds of resource to search, schemes, work-orders or operations, with eq or in. All three are searched when it is left out.
  • id: Passed on to each kind's search, such as not(in(id,<id>)) to leave out the resource being viewed.
  • organisation: With eq or in. On /v3/search, limits the results to those organisations. On /v3/shared-search, names the organisations the work is shared with, and is required.

Terms are combined with and. A filter with an or(...) returns nothing.

For more information on using named filters, see the docs

limit
integer<int64>
default:100

Limit the number of resources returned by the API

Required range: x >= 1
offset
integer<int64>
default:0

Offset the resources returned by the API

Required range: x >= 0
page
object

JSON:API pagination, as page[limit] and page[offset]. The same as the top-level limit and offset parameters; when both forms are sent, page[...] wins.

Response

Get a list of search results.

JSON API response object

data
A list of search results · object[]
required
meta
object
required
jsonapi
object
required
included
object[]

Related resources that can be included when search results are returned

A scheme