Skip to main content
GET
Search Persons

Authorizations

Authorization
string
header
required

Enter your API key

Query Parameters

name
string | null

Person full name (partial match)

first_name
string | null

Person first name

last_name
string | null

Person last name

city
string | null

Person city

birth_date
string | null

Person birth date

birth_year
integer | null

Person birth year

offset
integer
default:0

Number of items to skip

Required range: x >= 0
limit
integer
default:10

Maximum number of items to return

Required range: 1 <= x <= 100

Response

Successful Response

Model for person search response

persons
PersonSearchResult ยท object[]
required

List of matching persons

total_count
integer
required

Total number of persons found

page_count
integer
required

Number of pages available

pagination
PaginationInfo ยท object
required

Pagination information for the results