Skip to main content
GET
List work permits

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,
work_order,
operation,
scheme,
authorising_engineer,
competent_person,
team_leader
filter
string
default:""

Filters the response data based on the value provided.

Available filters:

  • eq(status,live): Filter by permit status
  • eq(kind,permit-to-dig): Filter by permit kind
  • eq(subject_type,work-orders): Filter by the associated subject type
  • eq(subject_id,<uuid>): Filter by the associated subject ID
  • contains(reference,PTD): Filter by reference
  • eq(organisation,<uuid>): Filter by organisation

For more information on using 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

List of work permits.

JSON API response object

data
A list of work permits · object[]
required
meta
object
required
jsonapi
object
required
included
object[]

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

An organisation