Skip to main content

POST Reference

POST 
/

This page is a supplemental reference for the POST method. See the Search API (GET & POST) page for full documentation including query parameters, response schemas, and examples.

Use POST for (1) Person — structured JSON, or (2) Search Pointer — follow-up using the pointer from a previous response. Required for long search pointers to avoid HTTP 414. API key can be sent as query parameter key.

Try it live

This playground is for reference only — API requests cannot be sent from this page. To test live API calls, use the Pipl Search API Demo or the Postman Collection.

Request​

Responses​

Successful search. Returns person(s), possible_persons, or no match.

Response Headers
    X-QPS-Allotted

    Queries allowed per second.

    X-QPS-Current

    Queries used in current second.

    X-QPS-Live-Allotted

    Live queries allowed per second.

    X-QPS-Live-Current

    Live queries used in current second.

    X-Package-Expiry

    API key package expiry date.

    X-Package-Current

    Requests used on current package.

    X-Package-Allotted

    Max requests on package.

    X-Quota-Allotted

    Self-imposed quota max.

    X-Quota-Current

    Requests used against quota.