List scheme share resources
Scheme Shares
List scheme shares
List scheme shares.
GET
List scheme share resources
Authorizations
Session token for authentication.
Query Parameters
Limit the number of resources returned by the API
Required range:
x >= 1Offset the resources returned by the API
Required range:
x >= 0A comma separated list of related resources to include.
Available options:
organisation_bridge, owner, shared_by, shared_with, scheme Filters the response data based on the value provided.
Available filters:
id: Filter by scheme share IDscheme.id: Filter by scheme IDbridge: Filter by organisation bridge IDowner: Filter by the organisation that created the shareshared_by: Filter by the organisation sharing the schemeshared_with: Filter by the organisation the scheme is shared withorganisation: Filter by any organisation involved in the share (shared_by or shared_with)
For more information on using named filters, see the docs