Skip to main content
GET
cURL

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:
versions,
latest_version
filter
string
default:""

Filters the response data based on the value provided.

Available filters:

  • prn_in: Filter by PRN (Permit Reference Number)
  • wrn_in: Filter by WRN (Works Reference Number)
  • status_in: Filter by permit status
  • wsr_in: Filter by WSR (Work Status Reference)
  • no_wsr: Filter for no WSR (Work Status Reference)
  • updated_before: Filter for permits updated before a specific date/time (RFC3339 format)

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

List all permits in the system.

JSON API response object

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