POST
/
v1
/
search
/
person
JavaScript
import Openregister from 'openregister';

const client = new Openregister({
  apiKey: 'My API Key',
});

const response = await client.search.findPersonV1();

console.log(response.pagination);
{
  "results": [
    {
      "id": "<string>",
      "name": "<string>",
      "city": "<string>",
      "date_of_birth": "<string>",
      "active": true
    }
  ],
  "pagination": {
    "page": 123,
    "per_page": 123,
    "total_pages": 123,
    "total_results": 123
  }
}

Search for a person

Search for a person by name, city, date of birth and additional filters. More information about filtering can be found here.

Authorizations

Authorization
string
header
required

API Key Authentication Provide your API key as a Bearer token in the Authorization header.

Body

application/json
query
object

Search query to filter people.

filters
object[]

Filters to filter people.

pagination
object

Pagination parameters.

Response

Successful search operation

results
object[]
required

List of people matching the search criteria.

pagination
object
required