Skip to content

Get a profile visibility rule

Identity module

GET/profile-visibility/{id}profileVisibilityRules.get

Visibility of one profile section or field. It can be lower than the profile, never higher. Returns one profile visibility rule with its `ETag`. A profile visibility rule the caller may not see returns 404.

  • Requires the capability me.profile.write.
  • OAuth scopes: me.
  • Error statuses: 400, 401, 404, 429. Errors are RFC 9457 problem details.

Path and query parameters

profileVisibilityRules.get: Path and query parameters
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the profile visibility rule.
fieldsFieldsNoSparse 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_]*)*$

Response 200: ProfileVisibilityRule

profileVisibilityRules.get: ProfileVisibilityRule
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the profile visibility rule.
created_atstring (date-time)YesWhen the row was created.
updated_atstring (date-time)YesWhen the row was last updated.
person_idstring (uuid)YesIdentifier of the profile owner.
section"photo" | "pronouns" | "headline" | "bio" | "location" | "skills" | "certifications" | "portfolio" | "rates" | "availability" | "languages" | "references" | "links" | "organizations"YesProfile section.
visibility"Private" | "Network" | "Public"YesVisibility chosen for the section.
{
  "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"
}

Code samples

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