Omni search

GET

https://api.sureshake.com/v2/search/omni

Authorization

BearerAuth
optional
HTTP

Query parameters

query
string
required
maxLength: 200 · minLength: 1
scope
optional
all
or
people
or
entities
or
reports
default: "all"
limit
optional
integer
Maximum results per group

maximum: 20 · minimum: 1 · default: 6

Returns

200

Default Response

JSON

status
complete
or
partial
or
unavailable
required
workspace
array of
object
required
Private results for the authenticated caller; empty for anonymous requests
- id
  string
  required
- type
  person
  or
  entity
  or
  report
  required
- title
  string
  required
- subtitle
  string
  or null
  required
- href
  string
  required
- badge
  string
  or null
  required
}
directory
array of
object
required
Published public directory results
- id
  string
  required
- type
  person
  or
  entity
  or
  report
  required
- title
  string
  required
- subtitle
  string
  or null
  required
- href
  string
  required
- badge
  string
  or null
  required
}
components
object
required
- workspacePeople
  available
  or
  unavailable
  or
  not_requested
  required
- workspaceEntities
  available
  or
  unavailable
  or
  not_requested
  required
- workspaceReports
  available
  or
  unavailable
  or
  not_requested
  required
- directory
  available
  or
  unavailable
  or
  disabled
  or
  not_requested
  required
}

400

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

401

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

429

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

500

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

Omni search

curl --request GET \
  --url 'https://api.sureshake.com/v2/search/omni?query=string'

const url = 'https://api.sureshake.com/v2/search/omni?query=string';
const options = {method: 'GET'};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

Response example

{
  "status": "complete",
  "workspace": [
    {
      "id": "string",
      "type": "person",
      "title": "string",
      "subtitle": "string",
      "href": "string",
      "badge": "string"
    }
  ],
  "directory": [
    {
      "id": "string",
      "type": "person",
      "title": "string",
      "subtitle": "string",
      "href": "string",
      "badge": "string"
    }
  ],
  "components": {
    "workspacePeople": "available",
    "workspaceEntities": "available",
    "workspaceReports": "available",
    "directory": "available"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}