Skip to main content
GET
List a site'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, an opaque member token, or a verified One Auth identity access token. The credential alone identifies the member and company. Member session and portal JWTs are read-only and are refused with 403 on every write.

Headers

If-None-Match
string

ETag from a previous response.

Path Parameters

site_id
string<uuid>
required

Public id of one of the member's sites.

Query Parameters

page[cursor]
string

Opaque cursor from meta.pagination.next_cursor, valid only for the same site. A malformed, tampered or expired cursor returns 400.

page[limit]
integer
default:25

Page size. Defaults to 25, at most 100.

Required range: 1 <= x <= 100

Response

A page of the site's shares.

One page of the shares of a site.

status
integer
required

HTTP status code (mirrors the response status line).

data
object[]
required

The shares of the page, oldest first.

meta
object
required

Envelope metadata present on every response.