Search Pointer

Each person returned in an API response will have a special attribute called “search pointer.” This string can be used for two purposes:

  • If the person was a possible person, run a follow-up search, which will pull up more data about this person.
  • If the person was a match, use the search pointer to cache a reference to this person. Searching by the search pointer will almost always return the same person again.

Because search pointers can be very long, searches made with them should be made via POST with the search pointer included in the request body. Requests using GET or with POST and the search pointer embedded directly in the URL are likely to return HTTP 414 Request-URI too long errors.


Replace SEARCH_POINTER_STRING with a valid search pointer.

curl \
 -d search_pointer='SEARCH_POINTER_STRING' \
 -d key=YOURKEY
from import SearchAPIRequest

request = SearchAPIRequest(search_pointer='SEARCH_POINTER_STRING', api_key="YOURKEY")
response = request.send()
require 'pipl'

response = search_pointer: 'SEARCH_POINTER_STRING', api_key: 'YOURKEY'

SearchAPIConfiguration configuration = new SearchConfiguration();
configuration.apiKey = 'YOURKEY'

SearchAPIRequest request = new SearchAPIRequest("SEARCH_POINTER_STRING", configuration);
SearchAPIResponse response = request.send()

require_once './piplapis/search.php';

$configuration = new PiplApi_SearchRequestConfiguration();
$configuration->api_key = 'YOURKEY';

$request = new PiplApi_SearchAPIRequest(array('search_pointer' => 'SEARCH_POINTER_STRING'), $configuration);
$response = $request->send();
using Pipl.APIs.Search;

SearchConfiguration searchConfiguration = new SearchConfiguration(apiKey: "YOURKEY");
var request = new SearchAPIRequest(searchPointer: "SEARCH_POINTER_STRING", requestConfiguration: searchConfiguration);
var response = request.SendAsync().Result;