Get a profile share
Gateway module
GET/profile-shares/{id}profileShares.get
A consent snapshot of profile fields shared with one org. Live updates stop on revoke after close. Returns one profile share with its `ETag`. A profile share 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
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the profile share. |
| 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_]*)*$ |
Response 200: ProfileShare
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the profile share. |
| created_at | string (date-time) | Yes | When the row was created. |
| updated_at | string (date-time) | Yes | When the row was last updated. |
| person_id | string (uuid) | null | Yes | Identifier of the sharing person. |
| organization_id | string (uuid) | null | Yes | Identifier of the external account sharing its company profile; null when a person shares their own. |
| shared_fields | array of object | Yes | Each shared field with the value at the time of sharing. |
| shared_at | string (date-time) | Yes | When the snapshot was taken. |
| revoked_at | string (date-time) | null | Yes | When consent was revoked. |
| engagement_id | string (uuid) | null | Yes | Identifier of the engagement the share serves; live updates flow only while it is open. |
{
"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",
"organization_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"shared_fields": [
{
"field_key": "headline",
"field_value": "Head Rigger"
}
],
"shared_at": "2026-10-08T14:30:00Z",
"revoked_at": "2026-10-08T14:30:00Z",
"engagement_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}Code samples
curl -X GET "$XOS_BASE_URL/profile-shares/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
-H "Authorization: Bearer $XOS_API_KEY"const { data, etag } = await xos.profileShares.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");response = xos.profile_shares.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")xos profile-shares get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f