Skip to main content
GET
cURL

Authorizations

X-Session-Token
string
header
required

Session token for authentication.

Path Parameters

org_id
string<uuid>
required

The unique identifier for the organisation.

scheme_id
string<uuid>
required

The unique identifier for the scheme.

Query Parameters

include
enum<string>[]

A comma separated list of related resources to include.

Available options:
appointments,
assignees,
contracts,
operations,
organisation,
permits,
properties,
site_managers,
streets,
teams,
template,
work_orders,
folder

Response

Get a scheme.

JSON API response object

data
object
required

A scheme

jsonapi
object
required
included
object[]

Related resources that can be included when a scheme is returned

An appointment