Suite search

GET/v1/search

Signed-in sessionLaunch key coreOperation suite_search

One query in the command palette finds tasks, projects, memories, files and people, grouped by type with the best matches first.

Query parameters

expectedAuthorizationVersionstring
limitnumber
typesstring
querystringRequired

Returns

contextobjectRequired
queryobjectRequired
groupsobject[]Required
omitted"file" | "memory" | "person" | "project" | "task"[]Required
freshnessobjectRequired

Errors

400, 401, 403, 404, 409, 429 and 503 return {"error": {"code", "message", "correlationId"}}.

GET/v1/search

curl "$SPECIFY_API_ORIGIN/v1/search?query=<query>" \
  -H "Authorization: Bearer $SPECIFY_SESSION_TOKEN" \
  -H "X-Specify-Account-Id: <accountId>" \
  -H "X-Specify-Service-Tenancy-Id: <serviceTenancyId>"

Response

{
  "result": {
    "context": {
      "accountId": "<accountId>",
      "serviceTenancyId": "<serviceTenancyId>",
      "authorizationVersion": "<authorizationVersion>"
    },
    "query": {
      "scope": "all",
      "text": "<text>"
    },
    "groups": [
      {
        "type": "file",
        "items": [
          {
            "id": "<id>",
            "type": "file",
            "title": "<title>",
            "subtitle": "<subtitle>",
            "href": "<href>",
            "updatedAt": "<updatedAt>",
            "preview": {
              "status": "<status>",
              "project": "<project>",
              "owner": "<owner>",
              "snippet": "<snippet>"
            },
            "score": 1
          }
        ],
        "partial": true
      }
    ],
    "omitted": [
      "file"
    ],
    "freshness": {
      "source": "canonical",
      "asOf": 1,
      "state": "catching_up",
      "watermark": "<watermark>"
    }
  }
}

Suite search

Headers

Query parameters

Returns

Errors