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

# Search

Retrieve a list of matching results for the provided search parameters.

**Required User Roles:**

* `ORG_ADMIN`
* `CERT_ADMIN`
* `REPORT_ADMIN`
* `SOURCE_ADMIN`
* `SOURCE_SUBADMIN`
* `ROLE_ADMIN`
* `ROLE_SUBADMIN`
* `HELPDESK`

**Required permission:** `sp:search:read`

For more information about the user roles refer to the [User Level Permissions](https://documentation.sailpoint.com/saas/help/common/users/user_levels.html).

<Note>
  External Documentation

  To learn more, visit the [SailPoint documentation](https://developer.sailpoint.com/docs/api/v3/search-post).
</Note>

## Basic Parameters

<div className="integrations-table">
  | Parameter      | Description                                                                                                                                                                                                |
  | -------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
  | Entities       | Select the Elasticsearch indices to include in the search scope.                                                                                                                                           |
  | Include Nested | Select whether to include nested objects in the returned search results.                                                                                                                                   |
  | Query          | The search query string used to match documents.<br /><br />**Note:** For more information refer to the [SailPoint Query Syntax](https://documentation.sailpoint.com/saas/help/search/building-query.html) |
</div>

## Advanced Parameters

<div className="integrations-table">
  | Parameter  | Description                                                        |
  | ---------- | ------------------------------------------------------------------ |
  | Limit      | The maximum number of results to return.                           |
  | Offset     | The number of results to skip before returning items.              |
  | Query Type | Select the query type to determine how the request is interpreted. |
</div>

## Example Output

```json theme={"dark"}
[
	{
		"description": "Admin access",
		"created": "2018-06-25T20:22:28.104Z",
		"modified": "2018-06-25T20:22:28.104Z",
		"synced": "2018-06-25T20:22:33.104Z",
		"enabled": true,
		"requestable": true,
		"requestCommentsRequired": false,
		"owner": {
			"type": "IDENTITY",
			"id": "2c9180a46faadee4016fb4e018c20639",
			"name": "Support",
			"email": "cloud-support@sailpoint.com"
		},
		"id": "2c9180825a6c1adc015a71c9023f0818",
		"name": "Cloud Eng",
		"source": {
			"id": "ff8081815757d4fb0157588f3d9d008f",
			"name": "Employees"
		},
		"entitlements": [
			{
				"hasPermissions": false,
				"description": "Cloud engineering",
				"attribute": "memberOf",
				"value": "CN=Cloud Engineering,DC=sailpoint,DC=COM",
				"schema": "group",
				"privileged": false,
				"id": "2c918084575812550157589064f33b89",
				"name": "CN=Cloud Engineering,DC=sailpoint,DC=COM"
			}
		],
		"entitlementCount": 5,
		"segments": [
			{
				"id": "b009b6e3-b56d-41d9-8735-cb532ea0b017",
				"name": "Test Segment"
			}
		],
		"segmentCount": 1,
		"tags": [
			"TAG_1",
			"TAG_2"
		],
		"apps": [
			{
				"id": "2c91808568c529c60168cca6f90c1313",
				"name": "Travel and Expense",
				"description": "Travel and Expense Application",
				"owner": {
					"type": "IDENTITY",
					"id": "2c9180a46faadee4016fb4e018c20639",
					"name": "John Doe",
					"email": "john.doe@sailpoint.com"
				}
			}
		],
		"pod": "pod01-useast1",
		"org": "org-name",
		"_type": "identity",
		"type": "identity",
		"_version": "v2"
	},
	{
		"id": "2c91808375d8e80a0175e1f88a575222",
		"name": "john.doe",
		"displayName": "Admin",
		"created": "2018-06-25T20:22:28.104Z",
		"modified": "2018-06-25T20:22:28.104Z",
		"synced": "string",
		"source": {
			"id": "2c91808b6e9e6fb8016eec1a2b6f7b5f",
			"name": "ODS-HR-Employees",
			"type": "SOURCE"
		},
		"segments": [
			{
				"id": "b009b6e3-b56d-41d9-8735-cb532ea0b017",
				"name": "Test Segment"
			}
		],
		"segmentCount": 1,
		"requestable": false,
		"cloudGoverned": false,
		"privileged": false,
		"tags": [
			"TAG_1",
			"TAG_2"
		],
		"attribute": "groups",
		"value": "1733ff75-441e-4327-9bfc-3ac445fd8cd1",
		"sourceSchemaObjectType": "group",
		"schema": "group",
		"hash": "c6fab95235584cca98a454a2f51e5683bc77d6a0",
		"permissions": [
			{
				"target": "SYS.GV_$TRANSACTION",
				"rights": [
					"SELECT"
				]
			}
		],
		"pod": "pod01-useast1",
		"org": "org-name",
		"_type": "identity",
		"type": "identity",
		"_version": "v2"
	},
	{
		"id": "2c91808568c529c60168cca6f90c1313",
		"name": "John Doe",
		"displayName": "Carol.Adams",
		"firstName": "Carol",
		"lastName": "Adams",
		"email": "Carol.Adams@sailpointdemo.com",
		"created": "2018-06-25T20:22:28.104Z",
		"modified": "2018-06-25T20:22:28.104Z",
		"phone": "+1 440-527-3672",
		"status": "UNREGISTERED",
		"manager": {
			"id": "2c9180867dfe694b017e208e27c05799",
			"name": "Amanda.Ross",
			"displayName": "Amanda.Ross"
		},
		"accounts": [
			{
				"id": "2c91808568c529c60168cca6f90c1313",
				"accountId": "John.Doe",
				"entitlementAttributes": {
					"moderator": true,
					"admin": true,
					"trust_level": "4"
				},
				"accountAttributes": {
					"type": "global",
					"admin": true,
					"trust_level": "4"
				}
			}
		],
		"accessCount": 5,
		"entitlementCount": 10,
		"roleCount": 1,
		"accessProfileCount": 1,
		"tags": [
			"TAG_1",
			"TAG_2"
		],
		"visibleSegments": [
			"All Employees"
		],
		"pod": "pod01-useast1",
		"org": "org-name",
		"_type": "identity",
		"type": "identity",
		"_version": "v2"
	}
]
```

## Workflow Library Example

[Search with Sailpoint and Send Results Via Email](https://library.blinkops.com/workflows/search-with-sailpoint-and-send-results-via-email)

<div className="iframe-wrapper">
  <div className="iframe-media">
    <img src="https://mintcdn.com/blinkops-2/ojHYuDeYX5FWuN8a/img/Icons/play-box.svg?fit=max&auto=format&n=ojHYuDeYX5FWuN8a&q=85&s=b8af968e71438a9499c3223c9bd29fb2" alt="Workflow Library" width="16" height="16" data-path="img/Icons/play-box.svg" />

    Preview this Workflow on desktop
  </div>

  <iframe className="iframe" src="https://library.blinkops.com/workflows/search-with-sailpoint-and-send-results-via-email/canvas" />
</div>
