Skip to main content
GET
The permit register: what each permit covers, how long it has left, and who signed it out.

Headers

Range
string

Limiting and Pagination

Range-Unit
string
default:items

Limiting and Pagination

Prefer
enum<string>

Preference

Available options:
count=none

Query Parameters

id
string
permit_number
string
permit_type
string
permit_type_label
string
title
string
status
string
description
string
hazards
string
work_order_id
string
work_order_number
string
work_order_title
string
shutdown_id
string
shutdown_code
string
site_id
string
site_name
string
location_id
string
location_name
string
asset_id
string
asset_number
string
asset_name
string
valid_from
string
valid_to
string
is_expired
string
in_force
string
minutes_remaining
string
issued_by_worker_id
string
issued_by_name
string
issued_at
string
accepted_by_worker_id
string
accepted_by_name
string
accepted_at
string
closed_by_worker_id
string
closed_by_name
string
closed_at
string
closure_notes
string
suspended_at
string
suspension_reason
string
cancelled_at
string
cancellation_reason
string
isolations
string
isolations_in_place
string
precautions
string
precautions_outstanding
string
crew
string
created_at
string
updated_at
string
row_version
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

Response

OK

accepted_at
string<timestamp with time zone>
accepted_by_name
string<character varying>
Maximum string length: 200
accepted_by_worker_id
string<uuid>

Note: This is a Foreign Key to assignable_workers.id.

asset_id
string<uuid>

Note: This is a Foreign Key to asset_contracts.asset_id.

asset_name
string<character varying>
Maximum string length: 250
asset_number
string<character varying>
Maximum string length: 80
cancellation_reason
string<character varying>
Maximum string length: 250
cancelled_at
string<timestamp with time zone>
closed_at
string<timestamp with time zone>
closed_by_name
string<character varying>
Maximum string length: 200
closed_by_worker_id
string<uuid>

Note: This is a Foreign Key to assignable_workers.id.

closure_notes
string<text>
created_at
string<timestamp with time zone>
crew
integer<bigint>
description
string<text>
hazards
string<text>
id
string<uuid>

Note: This is a Primary Key.

in_force
boolean<boolean>
is_expired
boolean<boolean>
isolations
integer<bigint>
isolations_in_place
integer<bigint>
issued_at
string<timestamp with time zone>
issued_by_name
string<character varying>
Maximum string length: 200
issued_by_worker_id
string<uuid>

Note: This is a Foreign Key to assignable_workers.id.

location_id
string<uuid>

Note: This is a Foreign Key to location_settings.id.

location_name
string<character varying>
Maximum string length: 200
minutes_remaining
integer<integer>
permit_number
string<character varying>
Maximum string length: 60
permit_type
string<character varying>
Maximum string length: 30
permit_type_label
string<text>
precautions
integer<bigint>
precautions_outstanding
integer<bigint>
row_version
integer<bigint>
shutdown_code
string<character varying>
Maximum string length: 40
shutdown_id
string<uuid>

Note: This is a Foreign Key to shutdowns.id.

site_id
string<uuid>

Note: This is a Foreign Key to entry_currencies.for_site_id.

site_name
string<character varying>
Maximum string length: 200
status
string<character varying>
Maximum string length: 20
suspended_at
string<timestamp with time zone>
suspension_reason
string<character varying>
Maximum string length: 250
title
string<character varying>
Maximum string length: 250
updated_at
string<timestamp with time zone>
valid_from
string<timestamp with time zone>
valid_to
string<timestamp with time zone>
work_order_id
string<uuid>

Note: This is a Foreign Key to asset_maintenance_plans.next_work_order_id.

work_order_number
string<character varying>
Maximum string length: 60
work_order_title
string<character varying>
Maximum string length: 250