Skip to content
XOS Developers

profileShares

Gateway module · 4 operations

List profile share rows

GET/profile-shares

A consent snapshot of profile fields shared with one org. Live updates stop on revoke after close. Returns a cursor page of profile share rows the caller may see. The default order is `created_at` ascending. Supports sparse fieldsets and the filter grammar.

Create a profile share

POST/profile-shares

A consent snapshot of profile fields shared with one org. Live updates stop on revoke after close. Creates a profile share. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.

Get a profile share

GET/profile-shares/{id}

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.

Revoke a profile share

POST/profile-shares/{id}/revoke

Stops future updates to the org. The org keeps records it must retain by law. Requires `Idempotency-Key`; a replay returns the original response. A rule that refuses the request returns 422 with `refusal` and `reason`.