> ## Documentation Index
> Fetch the complete documentation index at: https://docs.assetinfinity.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# The permit register: what each permit covers, how long it has left, and who signed it out.



## OpenAPI

````yaml /api-reference/openapi.json get /work_permits
openapi: 3.0.0
info:
  description: ''
  title: >-
    The only schema PostgREST exposes. Reads are security_invoker views; writes
    are SECURITY DEFINER functions. Rebuilt wholesale on every deploy — it holds
    no data.
  version: 12.2.3
servers:
  - url: https://app.assetinfinity.ai/api
security: []
tags:
  - name: Signing in
  - name: Profile
  - name: Assets
  - name: Asset lifecycle
  - name: Work lifecycle
  - name: Maintenance
  - name: Inventory
  - name: Inventory detail
  - name: Procurement
  - name: Contracts
  - name: Workforce
  - name: Capacity
  - name: Dispatch
  - name: Tools
  - name: Inspections
  - name: Verification
  - name: Reliability
  - name: Parts demand
  - name: Sensors and meters
  - name: Map
  - name: Floor plans
  - name: Labels
  - name: Lost and found
  - name: Root cause analysis
  - name: Reports
  - name: Audit center
  - name: Activity
  - name: Notifications
  - name: Channels
  - name: Search
  - name: Copilot
  - name: Import
  - name: Files
  - name: Sync
  - name: Support
  - name: Admin
  - name: Access
  - name: Lookups
  - name: Read models
  - name: Branding
  - name: Custom fields
  - name: Form studio
  - name: Workflows
  - name: Workflow studio
  - name: Rules
  - name: Statuses and transitions
  - name: Currencies and locales
  - name: Work configuration
  - name: Asset configuration
  - name: Inventory configuration
  - name: Tool configuration
  - name: Workforce configuration
  - name: Vendor and contract configuration
  - name: Document configuration
  - name: Inspection configuration
  - name: Sites, locations and the organisation
  - name: Platform
  - name: Amendments
  - name: Asset clone
  - name: Asset components
  - name: Asset register
  - name: Asset transfer
  - name: Audit feed
  - name: Billing
  - name: Bookings
  - name: Budgets
  - name: Bulk jobs
  - name: Calibration history
  - name: Capex plans
  - name: Conversations
  - name: Costing
  - name: Currency
  - name: Dashboards
  - name: Directory sync
  - name: Document control
  - name: Document folders
  - name: Document tree
  - name: Documents
  - name: Energy
  - name: Extracts
  - name: Features
  - name: Feeds
  - name: File exchange
  - name: Filing exceptions
  - name: Finance
  - name: Inbound mail
  - name: Keys
  - name: Knowledge
  - name: Licence
  - name: List views
  - name: Locations
  - name: Mapping
  - name: Mcp
  - name: Mcp oauth
  - name: Mfa
  - name: Numbering
  - name: Permits
  - name: Readers
  - name: Reference
  - name: Reference columns
  - name: Reference entry
  - name: Release
  - name: Scim
  - name: Security streams
  - name: Self verification
  - name: Setup
  - name: Shutdown
  - name: Sso
  - name: Telegram
  - name: Tenant switch
  - name: The caller's own work
  - name: The checklist library
  - name: Tools on a job, and who has them out
  - name: Tray
  - name: Vendor spend forecast
  - name: Vendors and contracts
  - name: Visitors
  - name: Work order execution
  - name: Work sequencing
  - name: Workforce detail
externalDocs:
  description: PostgREST Documentation
  url: https://postgrest.org/en/v12/references/api.html
paths:
  /work_permits:
    get:
      tags:
        - Permits
      summary: >-
        The permit register: what each permit covers, how long it has left, and
        who signed it out.
      parameters:
        - $ref: '#/components/parameters/rowFilter.work_permits.id'
        - $ref: '#/components/parameters/rowFilter.work_permits.permit_number'
        - $ref: '#/components/parameters/rowFilter.work_permits.permit_type'
        - $ref: '#/components/parameters/rowFilter.work_permits.permit_type_label'
        - $ref: '#/components/parameters/rowFilter.work_permits.title'
        - $ref: '#/components/parameters/rowFilter.work_permits.status'
        - $ref: '#/components/parameters/rowFilter.work_permits.description'
        - $ref: '#/components/parameters/rowFilter.work_permits.hazards'
        - $ref: '#/components/parameters/rowFilter.work_permits.work_order_id'
        - $ref: '#/components/parameters/rowFilter.work_permits.work_order_number'
        - $ref: '#/components/parameters/rowFilter.work_permits.work_order_title'
        - $ref: '#/components/parameters/rowFilter.work_permits.shutdown_id'
        - $ref: '#/components/parameters/rowFilter.work_permits.shutdown_code'
        - $ref: '#/components/parameters/rowFilter.work_permits.site_id'
        - $ref: '#/components/parameters/rowFilter.work_permits.site_name'
        - $ref: '#/components/parameters/rowFilter.work_permits.location_id'
        - $ref: '#/components/parameters/rowFilter.work_permits.location_name'
        - $ref: '#/components/parameters/rowFilter.work_permits.asset_id'
        - $ref: '#/components/parameters/rowFilter.work_permits.asset_number'
        - $ref: '#/components/parameters/rowFilter.work_permits.asset_name'
        - $ref: '#/components/parameters/rowFilter.work_permits.valid_from'
        - $ref: '#/components/parameters/rowFilter.work_permits.valid_to'
        - $ref: '#/components/parameters/rowFilter.work_permits.is_expired'
        - $ref: '#/components/parameters/rowFilter.work_permits.in_force'
        - $ref: '#/components/parameters/rowFilter.work_permits.minutes_remaining'
        - $ref: '#/components/parameters/rowFilter.work_permits.issued_by_worker_id'
        - $ref: '#/components/parameters/rowFilter.work_permits.issued_by_name'
        - $ref: '#/components/parameters/rowFilter.work_permits.issued_at'
        - $ref: '#/components/parameters/rowFilter.work_permits.accepted_by_worker_id'
        - $ref: '#/components/parameters/rowFilter.work_permits.accepted_by_name'
        - $ref: '#/components/parameters/rowFilter.work_permits.accepted_at'
        - $ref: '#/components/parameters/rowFilter.work_permits.closed_by_worker_id'
        - $ref: '#/components/parameters/rowFilter.work_permits.closed_by_name'
        - $ref: '#/components/parameters/rowFilter.work_permits.closed_at'
        - $ref: '#/components/parameters/rowFilter.work_permits.closure_notes'
        - $ref: '#/components/parameters/rowFilter.work_permits.suspended_at'
        - $ref: '#/components/parameters/rowFilter.work_permits.suspension_reason'
        - $ref: '#/components/parameters/rowFilter.work_permits.cancelled_at'
        - $ref: '#/components/parameters/rowFilter.work_permits.cancellation_reason'
        - $ref: '#/components/parameters/rowFilter.work_permits.isolations'
        - $ref: '#/components/parameters/rowFilter.work_permits.isolations_in_place'
        - $ref: '#/components/parameters/rowFilter.work_permits.precautions'
        - $ref: >-
            #/components/parameters/rowFilter.work_permits.precautions_outstanding
        - $ref: '#/components/parameters/rowFilter.work_permits.crew'
        - $ref: '#/components/parameters/rowFilter.work_permits.created_at'
        - $ref: '#/components/parameters/rowFilter.work_permits.updated_at'
        - $ref: '#/components/parameters/rowFilter.work_permits.row_version'
        - $ref: '#/components/parameters/select'
        - $ref: '#/components/parameters/order'
        - $ref: '#/components/parameters/range'
        - $ref: '#/components/parameters/rangeUnit'
        - $ref: '#/components/parameters/offset'
        - $ref: '#/components/parameters/limit'
        - $ref: '#/components/parameters/preferCount'
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/work_permits'
                type: array
            application/vnd.pgrst.object+json:
              schema:
                items:
                  $ref: '#/components/schemas/work_permits'
                type: array
            application/vnd.pgrst.object+json;nulls=stripped:
              schema:
                items:
                  $ref: '#/components/schemas/work_permits'
                type: array
            text/csv:
              schema:
                items:
                  $ref: '#/components/schemas/work_permits'
                type: array
          description: OK
        '206':
          description: Partial Content
components:
  parameters:
    rowFilter.work_permits.id:
      in: query
      name: id
      required: false
      schema:
        type: string
    rowFilter.work_permits.permit_number:
      in: query
      name: permit_number
      required: false
      schema:
        type: string
    rowFilter.work_permits.permit_type:
      in: query
      name: permit_type
      required: false
      schema:
        type: string
    rowFilter.work_permits.permit_type_label:
      in: query
      name: permit_type_label
      required: false
      schema:
        type: string
    rowFilter.work_permits.title:
      in: query
      name: title
      required: false
      schema:
        type: string
    rowFilter.work_permits.status:
      in: query
      name: status
      required: false
      schema:
        type: string
    rowFilter.work_permits.description:
      in: query
      name: description
      required: false
      schema:
        type: string
    rowFilter.work_permits.hazards:
      in: query
      name: hazards
      required: false
      schema:
        type: string
    rowFilter.work_permits.work_order_id:
      in: query
      name: work_order_id
      required: false
      schema:
        type: string
    rowFilter.work_permits.work_order_number:
      in: query
      name: work_order_number
      required: false
      schema:
        type: string
    rowFilter.work_permits.work_order_title:
      in: query
      name: work_order_title
      required: false
      schema:
        type: string
    rowFilter.work_permits.shutdown_id:
      in: query
      name: shutdown_id
      required: false
      schema:
        type: string
    rowFilter.work_permits.shutdown_code:
      in: query
      name: shutdown_code
      required: false
      schema:
        type: string
    rowFilter.work_permits.site_id:
      in: query
      name: site_id
      required: false
      schema:
        type: string
    rowFilter.work_permits.site_name:
      in: query
      name: site_name
      required: false
      schema:
        type: string
    rowFilter.work_permits.location_id:
      in: query
      name: location_id
      required: false
      schema:
        type: string
    rowFilter.work_permits.location_name:
      in: query
      name: location_name
      required: false
      schema:
        type: string
    rowFilter.work_permits.asset_id:
      in: query
      name: asset_id
      required: false
      schema:
        type: string
    rowFilter.work_permits.asset_number:
      in: query
      name: asset_number
      required: false
      schema:
        type: string
    rowFilter.work_permits.asset_name:
      in: query
      name: asset_name
      required: false
      schema:
        type: string
    rowFilter.work_permits.valid_from:
      in: query
      name: valid_from
      required: false
      schema:
        type: string
    rowFilter.work_permits.valid_to:
      in: query
      name: valid_to
      required: false
      schema:
        type: string
    rowFilter.work_permits.is_expired:
      in: query
      name: is_expired
      required: false
      schema:
        type: string
    rowFilter.work_permits.in_force:
      in: query
      name: in_force
      required: false
      schema:
        type: string
    rowFilter.work_permits.minutes_remaining:
      in: query
      name: minutes_remaining
      required: false
      schema:
        type: string
    rowFilter.work_permits.issued_by_worker_id:
      in: query
      name: issued_by_worker_id
      required: false
      schema:
        type: string
    rowFilter.work_permits.issued_by_name:
      in: query
      name: issued_by_name
      required: false
      schema:
        type: string
    rowFilter.work_permits.issued_at:
      in: query
      name: issued_at
      required: false
      schema:
        type: string
    rowFilter.work_permits.accepted_by_worker_id:
      in: query
      name: accepted_by_worker_id
      required: false
      schema:
        type: string
    rowFilter.work_permits.accepted_by_name:
      in: query
      name: accepted_by_name
      required: false
      schema:
        type: string
    rowFilter.work_permits.accepted_at:
      in: query
      name: accepted_at
      required: false
      schema:
        type: string
    rowFilter.work_permits.closed_by_worker_id:
      in: query
      name: closed_by_worker_id
      required: false
      schema:
        type: string
    rowFilter.work_permits.closed_by_name:
      in: query
      name: closed_by_name
      required: false
      schema:
        type: string
    rowFilter.work_permits.closed_at:
      in: query
      name: closed_at
      required: false
      schema:
        type: string
    rowFilter.work_permits.closure_notes:
      in: query
      name: closure_notes
      required: false
      schema:
        type: string
    rowFilter.work_permits.suspended_at:
      in: query
      name: suspended_at
      required: false
      schema:
        type: string
    rowFilter.work_permits.suspension_reason:
      in: query
      name: suspension_reason
      required: false
      schema:
        type: string
    rowFilter.work_permits.cancelled_at:
      in: query
      name: cancelled_at
      required: false
      schema:
        type: string
    rowFilter.work_permits.cancellation_reason:
      in: query
      name: cancellation_reason
      required: false
      schema:
        type: string
    rowFilter.work_permits.isolations:
      in: query
      name: isolations
      required: false
      schema:
        type: string
    rowFilter.work_permits.isolations_in_place:
      in: query
      name: isolations_in_place
      required: false
      schema:
        type: string
    rowFilter.work_permits.precautions:
      in: query
      name: precautions
      required: false
      schema:
        type: string
    rowFilter.work_permits.precautions_outstanding:
      in: query
      name: precautions_outstanding
      required: false
      schema:
        type: string
    rowFilter.work_permits.crew:
      in: query
      name: crew
      required: false
      schema:
        type: string
    rowFilter.work_permits.created_at:
      in: query
      name: created_at
      required: false
      schema:
        type: string
    rowFilter.work_permits.updated_at:
      in: query
      name: updated_at
      required: false
      schema:
        type: string
    rowFilter.work_permits.row_version:
      in: query
      name: row_version
      required: false
      schema:
        type: string
    select:
      description: Filtering Columns
      in: query
      name: select
      required: false
      schema:
        type: string
    order:
      description: Ordering
      in: query
      name: order
      required: false
      schema:
        type: string
    range:
      description: Limiting and Pagination
      in: header
      name: Range
      required: false
      schema:
        type: string
    rangeUnit:
      description: Limiting and Pagination
      in: header
      name: Range-Unit
      required: false
      schema:
        default: items
        type: string
    offset:
      description: Limiting and Pagination
      in: query
      name: offset
      required: false
      schema:
        type: string
    limit:
      description: Limiting and Pagination
      in: query
      name: limit
      required: false
      schema:
        type: string
    preferCount:
      description: Preference
      in: header
      name: Prefer
      required: false
      schema:
        enum:
          - count=none
        type: string
  schemas:
    work_permits:
      description: >-
        The permit register: what each permit covers, how long it has left, and
        who signed it out.
      properties:
        accepted_at:
          format: timestamp with time zone
          type: string
        accepted_by_name:
          format: character varying
          maxLength: 200
          type: string
        accepted_by_worker_id:
          description: >-
            Note:

            This is a Foreign Key to `assignable_workers.id`.<fk
            table='assignable_workers' column='id'/>
          format: uuid
          type: string
        asset_id:
          description: >-
            Note:

            This is a Foreign Key to `asset_contracts.asset_id`.<fk
            table='asset_contracts' column='asset_id'/>
          format: uuid
          type: string
        asset_name:
          format: character varying
          maxLength: 250
          type: string
        asset_number:
          format: character varying
          maxLength: 80
          type: string
        cancellation_reason:
          format: character varying
          maxLength: 250
          type: string
        cancelled_at:
          format: timestamp with time zone
          type: string
        closed_at:
          format: timestamp with time zone
          type: string
        closed_by_name:
          format: character varying
          maxLength: 200
          type: string
        closed_by_worker_id:
          description: >-
            Note:

            This is a Foreign Key to `assignable_workers.id`.<fk
            table='assignable_workers' column='id'/>
          format: uuid
          type: string
        closure_notes:
          format: text
          type: string
        created_at:
          format: timestamp with time zone
          type: string
        crew:
          format: bigint
          type: integer
        description:
          format: text
          type: string
        hazards:
          format: text
          type: string
        id:
          description: |-
            Note:
            This is a Primary Key.<pk/>
          format: uuid
          type: string
        in_force:
          format: boolean
          type: boolean
        is_expired:
          format: boolean
          type: boolean
        isolations:
          format: bigint
          type: integer
        isolations_in_place:
          format: bigint
          type: integer
        issued_at:
          format: timestamp with time zone
          type: string
        issued_by_name:
          format: character varying
          maxLength: 200
          type: string
        issued_by_worker_id:
          description: >-
            Note:

            This is a Foreign Key to `assignable_workers.id`.<fk
            table='assignable_workers' column='id'/>
          format: uuid
          type: string
        location_id:
          description: >-
            Note:

            This is a Foreign Key to `location_settings.id`.<fk
            table='location_settings' column='id'/>
          format: uuid
          type: string
        location_name:
          format: character varying
          maxLength: 200
          type: string
        minutes_remaining:
          format: integer
          type: integer
        permit_number:
          format: character varying
          maxLength: 60
          type: string
        permit_type:
          format: character varying
          maxLength: 30
          type: string
        permit_type_label:
          format: text
          type: string
        precautions:
          format: bigint
          type: integer
        precautions_outstanding:
          format: bigint
          type: integer
        row_version:
          format: bigint
          type: integer
        shutdown_code:
          format: character varying
          maxLength: 40
          type: string
        shutdown_id:
          description: >-
            Note:

            This is a Foreign Key to `shutdowns.id`.<fk table='shutdowns'
            column='id'/>
          format: uuid
          type: string
        site_id:
          description: >-
            Note:

            This is a Foreign Key to `entry_currencies.for_site_id`.<fk
            table='entry_currencies' column='for_site_id'/>
          format: uuid
          type: string
        site_name:
          format: character varying
          maxLength: 200
          type: string
        status:
          format: character varying
          maxLength: 20
          type: string
        suspended_at:
          format: timestamp with time zone
          type: string
        suspension_reason:
          format: character varying
          maxLength: 250
          type: string
        title:
          format: character varying
          maxLength: 250
          type: string
        updated_at:
          format: timestamp with time zone
          type: string
        valid_from:
          format: timestamp with time zone
          type: string
        valid_to:
          format: timestamp with time zone
          type: string
        work_order_id:
          description: >-
            Note:

            This is a Foreign Key to
            `asset_maintenance_plans.next_work_order_id`.<fk
            table='asset_maintenance_plans' column='next_work_order_id'/>
          format: uuid
          type: string
        work_order_number:
          format: character varying
          maxLength: 60
          type: string
        work_order_title:
          format: character varying
          maxLength: 250
          type: string
      type: object

````