Saltar al contenido

List profile visibility rule rows

Módulo Identity

GET/profile-visibilityprofileVisibilityRules.list

Visibility of one profile section or field. It can be lower than the profile, never higher. Returns a cursor page of profile visibility rule rows the caller may see. The default order is `created_at` ascending. Supports sparse fieldsets and the filter grammar.

  • Requiere la capacidad me.profile.write.
  • Alcances de OAuth: me.
  • Paginación por cursor: se aplican limit, cursor, fields, sort y filter.
  • Estados de error: 400, 401, 429. Los errores son detalles de problema RFC 9457.

Parámetros de ruta y de consulta

profileVisibilityRules.list: Parámetros de ruta y de consulta
CampoTipoObligatorioDescripción
limitLimitNoPage size. Default 50, maximum 200.Restricciones: range 1 to 200
cursorCursorNoOpaque cursor from `next_cursor` of the previous page.Restricciones: length 1 to any
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_]*)*$
sortSortNoSort keys, comma-separated; a leading `-` sorts descending. Without `sort`, the documented default order applies (coded lists sort in numeric code order).Restricciones: pattern ^-?[a-z_][a-z0-9_]*(,-?[a-z_][a-z0-9_]*)*$
filterFilterNoFilter 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.

Respuesta 200: una página de ProfileVisibilityRule

profileVisibilityRules.list: ProfileVisibilityRule
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the profile visibility rule.
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 profile owner.
section"photo" | "pronouns" | "headline" | "bio" | "location" | "skills" | "certifications" | "portfolio" | "rates" | "availability" | "languages" | "references" | "links" | "organizations"SíProfile section.
visibility"Private" | "Network" | "Public"SíVisibility chosen for the section.
{
  "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",
      "section": "photo",
      "visibility": "Private"
    }
  ],
  "next_cursor": null
}

Ejemplos de código

curl -X GET "$XOS_BASE_URL/profile-visibility" \
  -H "Authorization: Bearer $XOS_API_KEY"
for await (const row of xos.profileVisibilityRules.listAll()) {
  console.log(row);
}
for row in xos.profile_visibility_rules.list_all():
    print(row)
xos profile-visibility-rules list --all