List profile share rows

Gateway module

GET/profile-sharesprofileShares.list

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.

Requires the capability me.profile.write.
OAuth scopes: me.
Cursor-paginated: limit, cursor, fields, sort and filter apply.
Error statuses: 400, 401, 429. Errors are RFC 9457 problem details.

Path and query parameters

profileShares.list: Path and query parameters
Field	Type	Required	Description
limit	Limit	No	Page size. Default 50, maximum 200.Constraints: range 1 to 200
cursor	Cursor	No	Opaque cursor from `next_cursor` of the previous page.Constraints: length 1 to any
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_])*$
sort	Sort	No	Sort keys, comma-separated; a leading `-` sorts descending. Without `sort`, the documented default order applies (coded lists sort in numeric code order).Constraints: pattern ^-?[a-z_][a-z0-9_](,-?[a-z_][a-z0-9_])*$
filter	Filter	No	Filter 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.

Response 200: a page of ProfileShare

profileShares.list: 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.

{
  "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",
      "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"
    }
  ],
  "next_cursor": null
}

Code samples

curl -X GET "$XOS_BASE_URL/profile-shares" \
  -H "Authorization: Bearer $XOS_API_KEY"

for await (const row of xos.profileShares.listAll()) {
  console.log(row);
}

for row in xos.profile_shares.list_all():
    print(row)

xos profile-shares list --all