Skip to main content
GET
Get a work permit

Authorizations

X-Session-Token
string
header
required

Session token for authentication.

Path Parameters

work_permit_id
string<uuid>
required

The unique identifier for the work permit.

Query Parameters

include
enum<string>[]

A comma separated list of related resources to include.

Available options:
organisation,
work_order,
operation,
scheme,
authorising_engineer,
competent_person,
team_leader

Response

An individual work permit.

JSON API response object

data
object
required

A work permit

jsonapi
object
required
included
object[]

Related resources that can be included when a work permit is returned

An organisation