Skip to main content
GET
List the member's shares

Authorizations

Authorization
string
header
required

A member credential in the Authorization: Bearer header: a member session JWT, a portal JWT whose login is linked to a membership in that company, or an opaque member token. The credential alone identifies the member and company.

Query Parameters

filter[target_kind]
enum<string>

Only shares of this kind of target.

Available options:
media,
playlist,
product,
enrollment_pack,
page
filter[target_id]
string<uuid>

Only shares of this target; requires filter[target_kind].

filter[contact_id]
string<uuid>

Only shares to this contact of the member.

filter[channel]
enum<string>

Only shares created with this channel label.

Available options:
link,
email,
sms,
whatsapp,
facebook,
x,
qr
filter[since]
string<date-time>

Only shares created at or after this time.

page[cursor]
string

Opaque cursor from meta.pagination.next_cursor. Expires after three days.

page[limit]
integer
default:25

Maximum number of items returned.

Required range: 1 <= x <= 100

Response

A page of shares.

A page of shares.

status
integer
required

HTTP response status.

data
object[]
required

The page's shares, newest first.

meta
object
required

Envelope metadata with the list's pagination state.