Skip to main content
GET
Get a scheme contract

Authorizations

X-Session-Token
string
header
required

Session token for authentication.

Path Parameters

scheme_contract_id
string<uuid>
required

The unique identifier for the scheme contract.

Query Parameters

include
enum<string>[]

A comma separated list of related resources to include.

Available options:
organisation,
schemes

Response

Get a scheme contract.

JSON API response object

data
object
required

A scheme contract (or region) allocated from the network to a contractor

jsonapi
object
required
included
object[]

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

An organisation