Get an organization profile
Módulo Identity
GET/organization-profiles/{id}organizationProfiles.get
An organization's profile page. New organizations start Network. Returns one organization profile with its `ETag`. A organization profile the caller may not see returns 404.
- Requiere la capacidad org.settings.read.
- Alcances de OAuth: org.
- Estados de error: 400, 401, 404, 429. Los errores son detalles de problema RFC 9457.
Parámetros de ruta y de consulta
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| id | string (uuid) | Sí | Identifier of the organization profile. |
| fields | Fields | No | Sparse fieldset: a comma-separated list of top-level fields to return. `id` is always returned.Restricciones: pattern ^[a-z_][a-z0-9_]*(,[a-z_][a-z0-9_]*)*$ |
Respuesta 200: OrganizationProfile
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| id | string (uuid) | Sí | Identifier of the organization profile. |
| created_at | string (date-time) | Sí | When the row was created. |
| updated_at | string (date-time) | Sí | When the row was last updated. |
| organization_id | string (uuid) | Sí | Identifier of the organization. |
| about | string | null | Sí | About.Restricciones: length 1 to 20000 |
| visibility | ProfileVisibility | Sí | Profile visibility. Sections and fields may be set lower than the profile, never higher.Restricciones: one of "Public", "Network", "Private" |
| search_indexing | boolean | Sí | Whether search engines may index a public profile. |
| handle | string | Sí | 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.Restricciones: pattern ^[a-z0-9]([a-z0-9-]{1,38}[a-z0-9])$ |
| handle_changed_at | string (date-time) | null | Sí | When the handle last changed; null until the first change. Set by the database. |
| website_url | string (uri) | null | Sí | Website of the organization; https only. |
| contact_email | string (email) | null | Sí | Contact email of the organization, stored in lowercase. |
{
"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"
}Ejemplos de código
curl -X GET "$XOS_BASE_URL/organization-profiles/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
-H "Authorization: Bearer $XOS_API_KEY"const { data, etag } = await xos.organizationProfiles.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");response = xos.organization_profiles.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")xos organization-profiles get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f