List person rows
Identity module
GET/peoplepeople.list
One human, linked to one sign-in. Personal facts are owned by the person. Returns a cursor page of person rows the caller may see. The default order is `created_at` ascending. Supports sparse fieldsets and the filter grammar.
- Requires the capability people.directory.read.
- OAuth scopes: people.
- Cursor-paginated: limit, cursor, fields, sort and filter apply.
- Error statuses: 400, 401, 429. Errors are RFC 9457 problem details.
Path and query parameters
| Field | Type | Required | Description |
|---|---|---|---|
| limit | Limit | No | Page size. Default 50, maximum 200.Constraints: range 1 to 200 |
| cursor | Cursor | No | Opaque cursor from `next_cursor` of the previous page.Constraints: length 1 to any |
| fields | Fields | No | Sparse fieldset: a comma-separated list of top-level fields to return. `id` is always returned.Constraints: pattern ^[a-z_][a-z0-9_]*(,[a-z_][a-z0-9_]*)*$ |
| sort | Sort | No | Sort keys, comma-separated; a leading `-` sorts descending. Without `sort`, the documented default order applies (coded lists sort in numeric code order).Constraints: pattern ^-?[a-z_][a-z0-9_]*(,-?[a-z_][a-z0-9_]*)*$ |
| filter | Filter | No | Filter grammar `filter[field][op]=value`. Operators: eq, ne, lt, lte, gt, gte, in (comma-separated values), is_null (true or false) and contains. Conditions combine with AND. |
Response 200: a page of Person
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the person. |
| created_at | string (date-time) | Yes | When the row was created. |
| updated_at | string (date-time) | Yes | When the row was last updated. |
| full_name | string | null | Yes | Legal or full name.Constraints: length 1 to 300 |
| given_name | string | null | Yes | Optional given name, as the person writes it.Constraints: length 1 to 100 |
| family_name | string | null | Yes | Optional family name, as the person writes it.Constraints: length 1 to 100 |
{
"data": [
{
"id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"created_at": "2026-10-08T14:30:00Z",
"updated_at": "2026-10-08T14:30:00Z",
"full_name": "Alex Rivera",
"given_name": "Ivy",
"family_name": "Marchetti"
}
],
"next_cursor": null
}Code samples
curl -X GET "$XOS_BASE_URL/people" \
-H "Authorization: Bearer $XOS_API_KEY"for await (const row of xos.people.listAll()) {
console.log(row);
}for row in xos.people.list_all():
print(row)xos people list --all