Request Payload

The following API operations require a request payload of type SearchRequestPayload:

• POST https://api.pipe0.com/v1/search/run (create a search task)
• POST https://api.pipe0.com/v1/search/run/sync (create a search task and return the result)

Learn more about the difference between sync and async operations.

Here's a sample payload:

{
	"config": {
		"environment": "production",
		"widgets": {
			"enabled": false
		},
		"field_definitions": {
			"enabled": false
		}
	},
	"search": {
		"search_id": "people:profiles:crustdata@2",
		"config": {
			"limit": 100,
			"filters": {
				"current_job_titles": ["Software Engineer", "Developer"]
			}
		}
	}
}

Search request payload properties

config

The top-level config controls request-wide behavior. It is optional; omit it to use the defaults below.

config.environment

Execute your request in sandbox or production mode. Defaults to production.

config.widgets.enabled

Enable/disable widget metadata on result fields. Widgets are part of the search response and are often used to visualize results (e.g. provider logos). Defaults to false.

config.field_definitions.enabled

When true, the response includes a top-level field_definitions map that describes every column the search returns. This is opt-in and works for all searches: static searches derive their columns from the catalog, while dynamic searches (e.g. sheet:rows@1) supply their columns from the run. Defaults to false.

search

The search object containing the search configuration. Each request accepts a single search.

search.search_id

The unique identifier of a search. Find available search_ids in the search catalog.

search.config

Search configuration object. The full config object can be found in the search catalog. All searches require at least one filter in search.config.filters. Empty filter objects are invalid.

search.config.limit

Limit the number of search results. Find the default limit in the search catalog.

search.config.filters

A set of filters that varies by search. Find the available filters per search in the search catalog.