Get a person
Identity module
GET/people/{id}people.get
One human, linked to one sign-in. Personal facts are owned by the person. Returns one person with its `ETag`. A person the caller may not see returns 404.
- Requires the capability people.directory.read.
- OAuth scopes: people.
- Error statuses: 400, 401, 404, 429. Errors are RFC 9457 problem details.
Path and query parameters
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the person. |
| 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_]*)*$ |
Response 200: 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 |
{
"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"
}Code samples
curl -X GET "$XOS_BASE_URL/people/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
-H "Authorization: Bearer $XOS_API_KEY"const { data, etag } = await xos.people.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");response = xos.people.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")xos people get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f