Search the workspace or one project

Searches the workspace or one project. Results are ranked by relevance and include only records available to the token.

get/search

Request

Base URL: https://next-api.saturation.io/v1
URL: https://next-api.saturation.io/v1/search
Auth: HTTP bearer

Query parameters

qstring required

The search query. 1 to 500 characters.

typesSearchKind[]

Resource types to search. Omit to search every supported type.

[
  "transactions"
]

projectIdstring

A stable resource ID, such as prj_…, txn_…, or doc_….

Example:txn_8f2a1c9e

Limit results to one project.

limitinteger

Maximum number of items to return on a page. Capped at 100.

cursorstring

Cursor from the previous page's nextCursor. Use it with the same filters and sort.

withCountboolean

Include the total number of matching items. Defaults to false.

Response

Ranked search results.

nextCursorstring nullable

Cursor for the next page. Pass it as cursor with the same filters and sort. Null on the last page.

countinteger

Total matching hits; present only when withCount=true.

searchedTypesSearchKind[] required

Resource types searched for this request.

Example response

{
  "data": [
    {
      "kind": "transactions",
      "id": "txn_8f2a1c9e",
      "label": "Panavision Camera Package",
      "snippet": "Invoice 4471, Panavision rental",
      "score": 0.62
    }
  ],
  "nextCursor": "eyJpZCI6InR4bl84ZjJhMWM5ZSJ9",
  "searchedTypes": [
    "transactions",
    "documents",
    "budget-lines"
  ]
}

Changes

Changes to this operation have not been checked yet.