---
title: "Omni search"
---

> Documentation Index
> Fetch the complete documentation index at: https://docs.sureshake.com/llms.txt
> Use this file to discover all available pages before exploring further.

Path: Sureshake API › search

`GET /v2/search/omni`

## Authentication

Requires one of the following:

- 
- `BearerAuth`, http, header `Authorization`

## Query parameters

- `query` (`search-omni.query.query`; string, required)
  - minLength 1; maxLength 200
- `scope` (`search-omni.query.scope`; string, optional)
  - one of `"all"`, `"people"`, `"entities"`, `"reports"`; default `"all"`
- `limit` (`search-omni.query.limit`; integer, optional) — Maximum results per group
  - min 1; max 20; default `6`

## Code samples

### cURL

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

### TypeScript

```typescript
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));
```

### Python

```python
import requests

url = "https://api.sureshake.com/v2/search/omni?query=string"

response = requests.get(url)

print(response.text)
```

## Responses

### 200

Default Response

#### Example

```json
{
  "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"
  }
}
```

- `status` (`search-omni.response.200.status`; string, required)
  - one of `"complete"`, `"partial"`, `"unavailable"`
- `workspace` (`search-omni.response.200.workspace`; array<object>, required) — Private results for the authenticated caller; empty for anonymous requests
  - `id` (`search-omni.response.200.workspace.id`; string, required)
  - `type` (`search-omni.response.200.workspace.type`; string, required)
    - one of `"person"`, `"entity"`, `"report"`
  - `title` (`search-omni.response.200.workspace.title`; string, required)
  - `subtitle` (`search-omni.response.200.workspace.subtitle`; string, required, nullable)
  - `href` (`search-omni.response.200.workspace.href`; string, required)
  - `badge` (`search-omni.response.200.workspace.badge`; string, required, nullable)
- `directory` (`search-omni.response.200.directory`; array<object>, required) — Published public directory results
  - `id` (`search-omni.response.200.directory.id`; string, required)
  - `type` (`search-omni.response.200.directory.type`; string, required)
    - one of `"person"`, `"entity"`, `"report"`
  - `title` (`search-omni.response.200.directory.title`; string, required)
  - `subtitle` (`search-omni.response.200.directory.subtitle`; string, required, nullable)
  - `href` (`search-omni.response.200.directory.href`; string, required)
  - `badge` (`search-omni.response.200.directory.badge`; string, required, nullable)
- `components` (`search-omni.response.200.components`; object, required)
  - `workspacePeople` (`search-omni.response.200.components.workspacePeople`; string, required)
    - one of `"available"`, `"unavailable"`, `"not_requested"`
  - `workspaceEntities` (`search-omni.response.200.components.workspaceEntities`; string, required)
    - one of `"available"`, `"unavailable"`, `"not_requested"`
  - `workspaceReports` (`search-omni.response.200.components.workspaceReports`; string, required)
    - one of `"available"`, `"unavailable"`, `"not_requested"`
  - `directory` (`search-omni.response.200.components.directory`; string, required)
    - one of `"available"`, `"unavailable"`, `"disabled"`, `"not_requested"`

### 400

Default Response

#### Example

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

- `error` (`search-omni.response.400.error`; object, required)
  - `code` (`search-omni.response.400.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`search-omni.response.400.error.message`; string, required) — Human-readable error message
  - `details` (`search-omni.response.400.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`search-omni.response.400.error.traceId`; string, optional) — Unique ID for log correlation

### 401

Default Response

#### Example

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

- `error` (`search-omni.response.401.error`; object, required)
  - `code` (`search-omni.response.401.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`search-omni.response.401.error.message`; string, required) — Human-readable error message
  - `details` (`search-omni.response.401.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`search-omni.response.401.error.traceId`; string, optional) — Unique ID for log correlation

### 429

Default Response

#### Example

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

- `error` (`search-omni.response.429.error`; object, required)
  - `code` (`search-omni.response.429.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`search-omni.response.429.error.message`; string, required) — Human-readable error message
  - `details` (`search-omni.response.429.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`search-omni.response.429.error.traceId`; string, optional) — Unique ID for log correlation

### 500

Default Response

#### Example

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

- `error` (`search-omni.response.500.error`; object, required)
  - `code` (`search-omni.response.500.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`search-omni.response.500.error.message`; string, required) — Human-readable error message
  - `details` (`search-omni.response.500.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`search-omni.response.500.error.traceId`; string, optional) — Unique ID for log correlation


Source: https://docs.sureshake.com/reference/search-omni/index.md