Skip to main content
GET
List a scheme's history

Authorizations

X-Session-Token
string
header
required

Session token for authentication.

Path Parameters

scheme_id
string<uuid>
required

The unique identifier for the scheme.

Query Parameters

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
page
object

JSON:API pagination, as page[limit] and page[offset]. The same as the top-level limit and offset parameters; when both forms are sent, page[...] wins.

filter
string
default:""

Narrows a history to the events about one kind of record.

Available filters:

  • in(resource.type,[xxx]): Only the events about records of these types: schemes, work-orders or operations. Without it, a scheme's history holds the events about the scheme, its work orders and its operations, and a work order's holds the events about the work order and its operations.

For more information on using named filters, see the docs

include
enum<string>[]

A comma separated list of related resources to include. user includes the user who made each change.

Available options:
user

Response

List of audit events.

JSON API response object

data
A list of audit events · object[]
required
meta
object
required
jsonapi
object
required
included
object[]

Related resources that can be included when an audit event is returned

An organisation