Get the person rows. All users can call this route. Preview accounts are not in the list. An administrator gets all the fields but the password, the two-factor secrets, the login failure fields and the OIDC and SAML identities. An administrator cannot filter on these fields. With with_pass_hash=true, an administrator also gets the password hash. A client gets only the people of the teams of their open projects, with a short set of fields. The other users get a minimal set of fields. Add a query parameter for each column to filter on, for example first_name=John. An administrator can filter on all the columns but the sensitive ones. The other users can filter only on the fields they get. A user who is not a client can also filter on email. To get the rows that have one value of a list, give the list in JSON.
Query parameters
-
Include password hash (admin only)
Default value is
false. -
Page to get. Without this parameter, the response has all the rows.
-
Number of rows in a page. The default value is 100.
-
Without page, id of the last row of the previous request. With limit, it walks the whole list from the newest created row to the oldest, request after request, until one returns fewer rows than limit
-
Add the related data to each row
Default value is
false. -
Comma-separated list of the fields to get for each row. The response always has id and type. The names that are not fields are ignored.
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())
[
{}
]
{
"data": [
{}
],
"total": 100,
"nb_pages": 2,
"limit": 50,
"offset": 0,
"page": 1
}