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.

permit_id
string<uuid>
required

The unique identifier for the governance permit.

Query Parameters

include
enum<string>[]

A comma separated list of related resources to include.

Available options:
operation,
work_order,
street_manager_permit,
responsible_people

Response

An individual permit.

JSON API response object

data
object
required

A permit

jsonapi
object
required
included
object[]

Related resources that can be included when a permit is returned

An operation