Skip to main content
GET
List persons

Authorizations

Authorization
string
header
required

Send the API key as Authorization: Bearer <api_key>.

Query Parameters

limit
integer
default:50

Page size. Defaults to 50 and is capped at 100.

Required range: 1 <= x <= 100
cursor
string

Opaque pagination cursor returned by the previous response.

order
enum<string>
default:created_at desc

Sort order for list endpoints.

Available options:
created_at desc,
created_at asc,
updated_at desc,
updated_at asc
status
enum<string>
default:all

Filter by public person status; omit or use all for both statuses. not_missing is not an accepted list filter and returns 422.

Available options:
all,
missing,
found
query
string

Search text. Values shorter than 3 characters are ignored.

gender
string

Comma-separated gender values. Allowed values are female, male, and other.

Examples:

"female"

"female,male"

hospital
string

Comma-separated hospital handles.

Examples:

"miguel_perez_carreno"

"miguel_perez_carreno,domingo_luciani"

hospital_status
string

Comma-separated hospital status values. Allowed values are admitted, discharged, and deceased.

Examples:

"admitted"

"admitted,discharged"

shelter
string

Comma-separated shelter handles.

Examples:

"campo_de_golf_caribe"

"campo_de_golf_caribe,centro_acopio_caraballeda"

source
string

Comma-separated source handles. Use shelter_list for people imported from refuge and collection-center lists.

Examples:

"form"

"shelter_list"

"form,hospital_list,persons_list,shelter_list,venezuela_te_cuida,dra_florangel_vera,venezuela_reporta"

age_min
integer

Minimum age, inclusive.

Required range: x >= 0
age_max
integer

Maximum age, inclusive.

Required range: x >= 0

Response

Paginated persons.

data
object[]
required
pagination
object
required