GET /data/persons
Jwt authorization

Retrieve all persons. Supports filtering via query parameters and pagination. Admin users can include password hashes. Non-admin users only see minimal information.

Query parameters

  • page integer

    Page number for pagination

  • limit integer

    Number of results per page

  • relations boolean

    Whether to include relations

  • with_pass_hash boolean

    Include password hash (admin only)

Responses

  • 200 application/json

    Persons retrieved successfully

    One of:
    array-1 array[object] object-2 object
  • 400

    Invalid filter format or query error

GET /data/persons 
curl -X GET "http://api.example.com/data/persons?page=1&limit=50&relations=false&with_pass_hash=false" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Accept: application/json"
import requests

url = "http://api.example.com/data/persons"
headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Accept": "application/json"
}
params = {
    "page": 1,
    "limit": 50,
    "relations": false,
    "with_pass_hash": false
}
payload = None

response = requests.get(
    url,
    headers=headers,
    params=params,
    json=payload
)

response.raise_for_status()

if response.content:
    print(response.json())
curl \
 --request GET 'http://api.example.com/data/persons' \
 --header "Authorization: $API_KEY"
Response examples (200) 
[
  {}
]
{
  "data": [
    {}
  ],
  "total": 100,
  "nb_pages": 2,
  "limit": 50,
  "offset": 0,
  "page": 1
}