REST APIPersons
`GET /v1/persons` — the person index / name search, paged. Store-only: a
case-insensitive name match over the persons table, never a provider
fan-out.
cost 1 unitany plan
case-insensitive name match over the persons table, never a provider
fan-out.
Authorization
api_key X-API-Key<token>
In: header
Query Parameters
q?|
Case-insensitive substring of the person's full name. Empty/omitted matches everyone (the index read).
limit?|
Rows per page (default 50, capped at 200).
Format
int64offset?|
Rows to skip (default 0).
Format
int64Response Body
application/json
curl -X GET "https://example.com/v1/persons"{
"data": {
"items": [
{
"bio": {
"birth_country": "BRA",
"display_name": "string",
"dob": "2019-08-24",
"full_name": "string",
"headshot_url": "string",
"height_inches": 0,
"position": "SF",
"weight_lbs": 0
},
"id": "per_0a1b2c3d4e5f6g7h8i9j0k1l2m"
}
],
"page": 0,
"per_page": 0,
"total": 0
},
"meta": {
"cache": "HIT",
"fetched_at": "2025-10-15T18:30:00Z",
"request_id": "266ea41d-adf5-480b-af50-15b940c2b846",
"source": "postgres",
"version": "v1"
}
}