Response Object

The following API operations return a response of type SearchResponse.

• POST https://api.pipe0.com/v1/search/run (create a search task)
• GET https://api.pipe0.com/v1/search/check/{task_id} (check the processing state of a search task)
• POST https://api.pipe0.com/v1/search/run/sync (run a search task synchronously)

Learn more about the difference between sync and async operations.

Full response object

{
	"id": "jyg5w5p7unhcufkp8f7z5za8",
	"status": "completed",
	"search_id": "people:profiles:crustdata@1",
	"organization_id": "v417gjrw51ft55f85ueeqgpt",
	"errors": [],
	"total_pages": 2764,
	"pagination_type": "cursor",
	"next_page": {
		"config": {
			"filters": {
				"current_job_titles": ["Software Engineer", "Developer"]
			},
			"pagination": {
				"limit": 100,
				"cursor": "H4sIAMaPrWkC..."
			},
			"output_fields": {
				"name": { "alias": "", "enabled": true },
				"job_title": { "alias": "", "enabled": true },
				"profile_url": { "alias": "", "enabled": true }
			}
		},
		"search_id": "people:profiles:crustdata@1"
	},
	"results": [
		{
			"name": {
				"ui": {},
				"type": "string",
				"value": "Gayle Pouros",
				"format": "text",
				"status": "completed"
			},
			"job_title": {
				"ui": {},
				"type": "string",
				"value": "Product Intranet Manager",
				"format": "text",
				"status": "completed"
			}
		},
		{
			"name": {
				"ui": {},
				"type": "string",
				"value": "Mae Feest",
				"format": "text",
				"status": "completed"
			},
			"job_title": {
				"ui": {},
				"type": "string",
				"value": "Dynamic Data Liaison",
				"format": "text",
				"status": "completed"
			}
		}
	]
}

Response Properties

id

This is the task id. You can use this id to look up your processing result during and after processing. We store tasks for up to 15 days after processing is completed.

status

The status of the response object.

Status 'processing'

Your search request is being processed.

Status 'completed'

Processing has finished without errors.

Status 'failed'

Processing has failed. See the errors array for more information on why the failure occurred.

search_id

The search id that was used for this request.

organization_id

The organization that owns this search task.

errors[]

An array of errors. Empty when the search completed successfully. Contains error details when the search has failed.

total_pages

The total number of pages available for this search result.

pagination_type

The type of pagination used. Currently supports cursor.

next_page

Contains the configuration needed to fetch the next page of results. Use this object as the body of a subsequent request to paginate through results. This field is null when there are no more pages.

next_page.search_id

The search id to use for the next page request.

next_page.config

The config object pre-filled with the cursor and filters for the next page.

results[]

A list of search results. The fields of each object are normalized across searches. You can use the results as is or use them as input for a pipes request.