List organization profile rows
Identity module
GET/organization-profilesorganizationProfiles.list
An organization's profile page. New organizations start Network. Returns a cursor page of organization profile rows the caller may see. The default order is `created_at` ascending. Supports sparse fieldsets and the filter grammar.
- Requires the capability org.settings.read.
- OAuth scopes: org.
- 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 OrganizationProfile
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the organization profile. |
| created_at | string (date-time) | Yes | When the row was created. |
| updated_at | string (date-time) | Yes | When the row was last updated. |
| organization_id | string (uuid) | Yes | Identifier of the organization. |
| about | string | null | Yes | About.Constraints: length 1 to 20000 |
| 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. |
| website_url | string (uri) | null | Yes | Website of the organization; https only. |
| contact_email | string (email) | null | Yes | Contact email of the organization, stored in lowercase. |
{
"data": [
{
"id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"created_at": "2026-10-08T14:30:00Z",
"updated_at": "2026-10-08T14:30:00Z",
"organization_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"about": "Live event production for waterfront venues.",
"visibility": "Private",
"search_indexing": false,
"handle": "northwind-live",
"handle_changed_at": "2026-10-08T14:30:00Z",
"website_url": "https://northwindlive.example/files/site-plan.pdf",
"contact_email": "alex.rivera@northwindlive.example"
}
],
"next_cursor": null
}Code samples
curl -X GET "$XOS_BASE_URL/organization-profiles" \
-H "Authorization: Bearer $XOS_API_KEY"for await (const row of xos.organizationProfiles.listAll()) {
console.log(row);
}for row in xos.organization_profiles.list_all():
print(row)xos organization-profiles list --all