Skip to main content
GET
Get a scheme share resource

Authorizations

X-Session-Token
string
header
required

Session token for authentication.

Path Parameters

scheme_share_id
string<uuid>
required

The unique identifier for the scheme share resource.

Query Parameters

include
enum<string>[]

A comma separated list of related resources to include.

Available options:
organisation_bridge,
owner,
shared_by,
shared_with,
scheme

Response

Get a scheme share.

JSON API response object

data
object
required

A scheme share

jsonapi
object
required
included
object[]

Related resources that can be included when a scheme share is returned

An organisation