Saltar al contenido

Get a person profile

Módulo Identity

GET/person-profiles/{id}personProfiles.get

A person's profile page, owned by the person. New profiles start Private. Returns one person profile with its `ETag`. A person profile the caller may not see returns 404.

  • Requiere la capacidad people.directory.read.
  • Alcances de OAuth: people.
  • Estados de error: 400, 401, 404, 429. Los errores son detalles de problema RFC 9457.

Parámetros de ruta y de consulta

personProfiles.get: Parámetros de ruta y de consulta
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the person profile.
fieldsFieldsNoSparse 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: PersonProfile

personProfiles.get: PersonProfile
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the person profile.
created_atstring (date-time)SíWhen the row was created.
updated_atstring (date-time)SíWhen the row was last updated.
person_idstring (uuid)SíIdentifier of the person.
headlinestring | nullSíHeadline.Restricciones: length 1 to 300
biostring | nullSíBio.Restricciones: length 1 to 20000
pronounsstring | nullSíPronouns, optional.Restricciones: length 1 to 300
localitystring | nullSíCity.Restricciones: length 1 to 300
countrystring | nullSíISO 3166-1 alpha-2 country code.Restricciones: pattern ^[A-Z]{2}$
visibilityProfileVisibilitySíProfile visibility. Sections and fields may be set lower than the profile, never higher.Restricciones: one of "Public", "Network", "Private"
search_indexingbooleanSíWhether search engines may index a public profile.
handlestringSí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_atstring (date-time) | nullSíWhen the handle last changed; null until the first change. Set by the database.
preferred_namestring | nullSíName the person goes by.Restricciones: length 1 to 100
{
  "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"
}

Ejemplos de código

curl -X GET "$XOS_BASE_URL/person-profiles/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY"
const { data, etag } = await xos.personProfiles.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");
response = xos.person_profiles.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")
xos person-profiles get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f