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 } }
API Key Authentication Provide your API key as a Bearer token in the Authorization header.
Search query to filter people.
Show child attributes
Filters to filter people.
date_of_birth
city
active
Pagination parameters.
Page number to return.
Number of results per page.
Successful search operation
List of people matching the search criteria.
Unique person identifier. Example: 1234-5678-9012-345678901234
Name of the person. Example: "Max Mustermann"
City of the person. Example: "Berlin"
Date of birth of the person. Format: ISO 8601 (YYYY-MM-DD) Example: "1990-01-01"
Person status - true if active, false if inactive.
Current page number.
Total number of pages.
Total number of results.