> ## 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 controlled document library. control_state is what the calendar says, status is what a

> person decided — they disagree for one night after a document lapses, and the screen shows the
calendar.



## OpenAPI

````yaml /api-reference/openapi.json get /documents
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:
  /documents:
    get:
      tags:
        - Document control
      summary: >-
        The controlled document library. control_state is what the calendar
        says, status is what a
      description: >-
        person decided — they disagree for one night after a document lapses,
        and the screen shows the

        calendar.
      parameters:
        - $ref: '#/components/parameters/rowFilter.documents.id'
        - $ref: '#/components/parameters/rowFilter.documents.document_number'
        - $ref: '#/components/parameters/rowFilter.documents.title'
        - $ref: '#/components/parameters/rowFilter.documents.description'
        - $ref: '#/components/parameters/rowFilter.documents.document_category_id'
        - $ref: '#/components/parameters/rowFilter.documents.category'
        - $ref: '#/components/parameters/rowFilter.documents.document_folder_id'
        - $ref: '#/components/parameters/rowFilter.documents.folder'
        - $ref: '#/components/parameters/rowFilter.documents.folder_is_restricted'
        - $ref: '#/components/parameters/rowFilter.documents.document_type'
        - $ref: '#/components/parameters/rowFilter.documents.status'
        - $ref: '#/components/parameters/rowFilter.documents.current_version_number'
        - $ref: '#/components/parameters/rowFilter.documents.file_id'
        - $ref: '#/components/parameters/rowFilter.documents.file_name'
        - $ref: '#/components/parameters/rowFilter.documents.content_type'
        - $ref: '#/components/parameters/rowFilter.documents.size_bytes'
        - $ref: '#/components/parameters/rowFilter.documents.file_is_available'
        - $ref: '#/components/parameters/rowFilter.documents.owner_user_id'
        - $ref: '#/components/parameters/rowFilter.documents.owner'
        - $ref: '#/components/parameters/rowFilter.documents.approved_by_user_id'
        - $ref: '#/components/parameters/rowFilter.documents.approved_by'
        - $ref: '#/components/parameters/rowFilter.documents.approved_at'
        - $ref: '#/components/parameters/rowFilter.documents.language_id'
        - $ref: '#/components/parameters/rowFilter.documents.language'
        - $ref: '#/components/parameters/rowFilter.documents.issued_on'
        - $ref: '#/components/parameters/rowFilter.documents.effective_from'
        - $ref: '#/components/parameters/rowFilter.documents.expires_on'
        - $ref: '#/components/parameters/rowFilter.documents.review_due_on'
        - $ref: '#/components/parameters/rowFilter.documents.review_interval_months'
        - $ref: '#/components/parameters/rowFilter.documents.issuing_body'
        - $ref: '#/components/parameters/rowFilter.documents.reference_number'
        - $ref: '#/components/parameters/rowFilter.documents.withdrawal_reason'
        - $ref: '#/components/parameters/rowFilter.documents.control_state'
        - $ref: '#/components/parameters/rowFilter.documents.days_until_expiry'
        - $ref: '#/components/parameters/rowFilter.documents.days_until_review'
        - $ref: '#/components/parameters/rowFilter.documents.linked_records'
        - $ref: '#/components/parameters/rowFilter.documents.version_count'
        - $ref: '#/components/parameters/rowFilter.documents.pending_version_number'
        - $ref: '#/components/parameters/rowFilter.documents.is_available_offline'
        - $ref: '#/components/parameters/rowFilter.documents.is_active'
        - $ref: '#/components/parameters/rowFilter.documents.created_at'
        - $ref: '#/components/parameters/rowFilter.documents.updated_at'
        - $ref: '#/components/parameters/rowFilter.documents.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/documents'
                type: array
            application/vnd.pgrst.object+json:
              schema:
                items:
                  $ref: '#/components/schemas/documents'
                type: array
            application/vnd.pgrst.object+json;nulls=stripped:
              schema:
                items:
                  $ref: '#/components/schemas/documents'
                type: array
            text/csv:
              schema:
                items:
                  $ref: '#/components/schemas/documents'
                type: array
          description: OK
        '206':
          description: Partial Content
components:
  parameters:
    rowFilter.documents.id:
      in: query
      name: id
      required: false
      schema:
        type: string
    rowFilter.documents.document_number:
      in: query
      name: document_number
      required: false
      schema:
        type: string
    rowFilter.documents.title:
      in: query
      name: title
      required: false
      schema:
        type: string
    rowFilter.documents.description:
      in: query
      name: description
      required: false
      schema:
        type: string
    rowFilter.documents.document_category_id:
      in: query
      name: document_category_id
      required: false
      schema:
        type: string
    rowFilter.documents.category:
      in: query
      name: category
      required: false
      schema:
        type: string
    rowFilter.documents.document_folder_id:
      in: query
      name: document_folder_id
      required: false
      schema:
        type: string
    rowFilter.documents.folder:
      in: query
      name: folder
      required: false
      schema:
        type: string
    rowFilter.documents.folder_is_restricted:
      in: query
      name: folder_is_restricted
      required: false
      schema:
        type: string
    rowFilter.documents.document_type:
      in: query
      name: document_type
      required: false
      schema:
        type: string
    rowFilter.documents.status:
      in: query
      name: status
      required: false
      schema:
        type: string
    rowFilter.documents.current_version_number:
      in: query
      name: current_version_number
      required: false
      schema:
        type: string
    rowFilter.documents.file_id:
      in: query
      name: file_id
      required: false
      schema:
        type: string
    rowFilter.documents.file_name:
      in: query
      name: file_name
      required: false
      schema:
        type: string
    rowFilter.documents.content_type:
      in: query
      name: content_type
      required: false
      schema:
        type: string
    rowFilter.documents.size_bytes:
      in: query
      name: size_bytes
      required: false
      schema:
        type: string
    rowFilter.documents.file_is_available:
      in: query
      name: file_is_available
      required: false
      schema:
        type: string
    rowFilter.documents.owner_user_id:
      in: query
      name: owner_user_id
      required: false
      schema:
        type: string
    rowFilter.documents.owner:
      in: query
      name: owner
      required: false
      schema:
        type: string
    rowFilter.documents.approved_by_user_id:
      in: query
      name: approved_by_user_id
      required: false
      schema:
        type: string
    rowFilter.documents.approved_by:
      in: query
      name: approved_by
      required: false
      schema:
        type: string
    rowFilter.documents.approved_at:
      in: query
      name: approved_at
      required: false
      schema:
        type: string
    rowFilter.documents.language_id:
      in: query
      name: language_id
      required: false
      schema:
        type: string
    rowFilter.documents.language:
      in: query
      name: language
      required: false
      schema:
        type: string
    rowFilter.documents.issued_on:
      in: query
      name: issued_on
      required: false
      schema:
        type: string
    rowFilter.documents.effective_from:
      in: query
      name: effective_from
      required: false
      schema:
        type: string
    rowFilter.documents.expires_on:
      in: query
      name: expires_on
      required: false
      schema:
        type: string
    rowFilter.documents.review_due_on:
      in: query
      name: review_due_on
      required: false
      schema:
        type: string
    rowFilter.documents.review_interval_months:
      in: query
      name: review_interval_months
      required: false
      schema:
        type: string
    rowFilter.documents.issuing_body:
      in: query
      name: issuing_body
      required: false
      schema:
        type: string
    rowFilter.documents.reference_number:
      in: query
      name: reference_number
      required: false
      schema:
        type: string
    rowFilter.documents.withdrawal_reason:
      in: query
      name: withdrawal_reason
      required: false
      schema:
        type: string
    rowFilter.documents.control_state:
      in: query
      name: control_state
      required: false
      schema:
        type: string
    rowFilter.documents.days_until_expiry:
      in: query
      name: days_until_expiry
      required: false
      schema:
        type: string
    rowFilter.documents.days_until_review:
      in: query
      name: days_until_review
      required: false
      schema:
        type: string
    rowFilter.documents.linked_records:
      in: query
      name: linked_records
      required: false
      schema:
        type: string
    rowFilter.documents.version_count:
      in: query
      name: version_count
      required: false
      schema:
        type: string
    rowFilter.documents.pending_version_number:
      in: query
      name: pending_version_number
      required: false
      schema:
        type: string
    rowFilter.documents.is_available_offline:
      in: query
      name: is_available_offline
      required: false
      schema:
        type: string
    rowFilter.documents.is_active:
      in: query
      name: is_active
      required: false
      schema:
        type: string
    rowFilter.documents.created_at:
      in: query
      name: created_at
      required: false
      schema:
        type: string
    rowFilter.documents.updated_at:
      in: query
      name: updated_at
      required: false
      schema:
        type: string
    rowFilter.documents.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:
    documents:
      description: >-
        The controlled document library. control_state is what the calendar
        says, status is what a

        person decided — they disagree for one night after a document lapses,
        and the screen shows the

        calendar.
      properties:
        approved_at:
          format: timestamp with time zone
          type: string
        approved_by:
          format: character varying
          maxLength: 200
          type: string
        approved_by_user_id:
          description: >-
            Note:

            This is a Foreign Key to `capex_invite_candidates.id`.<fk
            table='capex_invite_candidates' column='id'/>
          format: uuid
          type: string
        category:
          format: character varying
          maxLength: 200
          type: string
        content_type:
          format: character varying
          maxLength: 150
          type: string
        control_state:
          format: character varying
          type: string
        created_at:
          format: timestamp with time zone
          type: string
        current_version_number:
          format: integer
          type: integer
        days_until_expiry:
          format: integer
          type: integer
        days_until_review:
          format: integer
          type: integer
        description:
          format: text
          type: string
        document_category_id:
          description: >-
            Note:

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

            This is a Foreign Key to `document_folders.id`.<fk
            table='document_folders' column='id'/>
          format: uuid
          type: string
        document_number:
          format: character varying
          maxLength: 80
          type: string
        document_type:
          format: character varying
          maxLength: 40
          type: string
        effective_from:
          format: date
          type: string
        expires_on:
          format: date
          type: string
        file_id:
          format: uuid
          type: string
        file_is_available:
          format: boolean
          type: boolean
        file_name:
          format: character varying
          maxLength: 250
          type: string
        folder:
          format: character varying
          maxLength: 150
          type: string
        folder_is_restricted:
          format: boolean
          type: boolean
        id:
          description: |-
            Note:
            This is a Primary Key.<pk/>
          format: uuid
          type: string
        is_active:
          format: boolean
          type: boolean
        is_available_offline:
          format: boolean
          type: boolean
        issued_on:
          format: date
          type: string
        issuing_body:
          format: character varying
          maxLength: 200
          type: string
        language:
          format: character varying
          maxLength: 100
          type: string
        language_id:
          format: uuid
          type: string
        linked_records:
          format: bigint
          type: integer
        owner:
          format: character varying
          maxLength: 200
          type: string
        owner_user_id:
          description: >-
            Note:

            This is a Foreign Key to `capex_invite_candidates.id`.<fk
            table='capex_invite_candidates' column='id'/>
          format: uuid
          type: string
        pending_version_number:
          format: integer
          type: integer
        reference_number:
          format: character varying
          maxLength: 120
          type: string
        review_due_on:
          format: date
          type: string
        review_interval_months:
          format: integer
          type: integer
        row_version:
          format: bigint
          type: integer
        size_bytes:
          format: bigint
          type: integer
        status:
          format: character varying
          maxLength: 20
          type: string
        title:
          format: character varying
          maxLength: 250
          type: string
        updated_at:
          format: timestamp with time zone
          type: string
        version_count:
          format: bigint
          type: integer
        withdrawal_reason:
          format: character varying
          maxLength: 500
          type: string
      type: object

````