Skip to main content
GET
List scheme contracts

Authorizations

X-Session-Token
string
header
required

Session token for authentication.

Query Parameters

include
enum<string>[]

A comma separated list of related resources to include.

Available options:
organisation,
schemes
filter
string
default:""

Filters the response data based on the value provided.

Available filters:

  • eq(id,xxx): Filter scheme contracts by ID.
  • contains(name,xxx): Filter scheme contracts where name contains value.
  • eq(organisation,xxx): Filter scheme contracts by organisation ID.
  • eq(scheme,xxx): Filter scheme contracts that contain the given scheme ID.

For more information on using named filters, see the docs

limit
integer<int64>
default:100

Limit the number of resources returned by the API

Required range: x >= 1
offset
integer<int64>
default:0

Offset the resources returned by the API

Required range: x >= 0

Response

Get a list of scheme contracts.

JSON API response object

data
A list of scheme contracts · object[]
required
meta
object
required
jsonapi
object
required
included
object[]

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

An organisation