List person profile rows

Identity module

GET/person-profilespersonProfiles.list

A person's profile page, owned by the person. New profiles start Private. Returns a cursor page of person profile 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

personProfiles.list: 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 PersonProfile

personProfiles.list: PersonProfile
Field	Type	Required	Description
id	string (uuid)	Yes	Identifier of the person profile.
created_at	string (date-time)	Yes	When the row was created.
updated_at	string (date-time)	Yes	When the row was last updated.
person_id	string (uuid)	Yes	Identifier of the person.
headline	string \| null	Yes	Headline.Constraints: length 1 to 300
bio	string \| null	Yes	Bio.Constraints: length 1 to 20000
pronouns	string \| null	Yes	Pronouns, optional.Constraints: length 1 to 300
locality	string \| null	Yes	City.Constraints: length 1 to 300
country	string \| null	Yes	ISO 3166-1 alpha-2 country code.Constraints: pattern ^[A-Z]{2}$
visibility	ProfileVisibility	Yes	Profile visibility. Sections and fields may be set lower than the profile, never higher.Constraints: one of "Public", "Network", "Private"
search_indexing	boolean	Yes	Whether search engines may index a public profile.
handle	string	Yes	Unique handle for /u/{handle} or /c/{handle}: 3 to 40 lowercase letters, digits and single hyphens. Changeable once every 30 days; the old handle redirects for 90 days.Constraints: pattern ^[a-z0-9]([a-z0-9-]{1,38}[a-z0-9])$
handle_changed_at	string (date-time) \| null	Yes	When the handle last changed; null until the first change. Set by the database.
preferred_name	string \| null	Yes	Name the person goes by.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",
      "person_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
      "headline": "Head Rigger, Festivals and Arenas",
      "bio": "Fifteen years rigging touring shows.",
      "pronouns": "they/them",
      "locality": "Miami",
      "country": "US",
      "visibility": "Private",
      "search_indexing": false,
      "handle": "northwind-live",
      "handle_changed_at": "2026-10-08T14:30:00Z",
      "preferred_name": "Alex"
    }
  ],
  "next_cursor": null
}

Code samples

curl -X GET "$XOS_BASE_URL/person-profiles" \
  -H "Authorization: Bearer $XOS_API_KEY"

for await (const row of xos.personProfiles.listAll()) {
  console.log(row);
}

for row in xos.person_profiles.list_all():
    print(row)

xos person-profiles list --all