> ## 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.

# Every key this organisation has issued — its prefix, its scopes, its state and what it has

> been used for. Never the key: it exists in one place, and that place is wherever the person who
was shown it once put it.



## OpenAPI

````yaml /api-reference/openapi.json get /api_keys
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:
  /api_keys:
    get:
      tags:
        - Keys
      summary: >-
        Every key this organisation has issued — its prefix, its scopes, its
        state and what it has
      description: >-
        been used for. Never the key: it exists in one place, and that place is
        wherever the person who

        was shown it once put it.
      parameters:
        - $ref: '#/components/parameters/rowFilter.api_keys.id'
        - $ref: '#/components/parameters/rowFilter.api_keys.name'
        - $ref: '#/components/parameters/rowFilter.api_keys.key_prefix'
        - $ref: '#/components/parameters/rowFilter.api_keys.service_account_id'
        - $ref: '#/components/parameters/rowFilter.api_keys.service_account_code'
        - $ref: '#/components/parameters/rowFilter.api_keys.service_account_name'
        - $ref: '#/components/parameters/rowFilter.api_keys.scopes'
        - $ref: '#/components/parameters/rowFilter.api_keys.is_narrowed'
        - $ref: '#/components/parameters/rowFilter.api_keys.reader_id'
        - $ref: '#/components/parameters/rowFilter.api_keys.reader_code'
        - $ref: '#/components/parameters/rowFilter.api_keys.expires_at'
        - $ref: '#/components/parameters/rowFilter.api_keys.status'
        - $ref: '#/components/parameters/rowFilter.api_keys.last_used_at'
        - $ref: '#/components/parameters/rowFilter.api_keys.never_used'
        - $ref: '#/components/parameters/rowFilter.api_keys.revoked_at'
        - $ref: '#/components/parameters/rowFilter.api_keys.revoked_reason'
        - $ref: '#/components/parameters/rowFilter.api_keys.revoked_by_name'
        - $ref: '#/components/parameters/rowFilter.api_keys.superseded_at'
        - $ref: '#/components/parameters/rowFilter.api_keys.rotated_from_id'
        - $ref: '#/components/parameters/rowFilter.api_keys.rotated_from_prefix'
        - $ref: '#/components/parameters/rowFilter.api_keys.successor_id'
        - $ref: '#/components/parameters/rowFilter.api_keys.successor_prefix'
        - $ref: '#/components/parameters/rowFilter.api_keys.exchanges_7d'
        - $ref: '#/components/parameters/rowFilter.api_keys.refusals_7d'
        - $ref: '#/components/parameters/rowFilter.api_keys.created_at'
        - $ref: '#/components/parameters/rowFilter.api_keys.created_by_name'
        - $ref: '#/components/parameters/rowFilter.api_keys.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/api_keys'
                type: array
            application/vnd.pgrst.object+json:
              schema:
                items:
                  $ref: '#/components/schemas/api_keys'
                type: array
            application/vnd.pgrst.object+json;nulls=stripped:
              schema:
                items:
                  $ref: '#/components/schemas/api_keys'
                type: array
            text/csv:
              schema:
                items:
                  $ref: '#/components/schemas/api_keys'
                type: array
          description: OK
        '206':
          description: Partial Content
components:
  parameters:
    rowFilter.api_keys.id:
      in: query
      name: id
      required: false
      schema:
        type: string
    rowFilter.api_keys.name:
      in: query
      name: name
      required: false
      schema:
        type: string
    rowFilter.api_keys.key_prefix:
      in: query
      name: key_prefix
      required: false
      schema:
        type: string
    rowFilter.api_keys.service_account_id:
      in: query
      name: service_account_id
      required: false
      schema:
        type: string
    rowFilter.api_keys.service_account_code:
      in: query
      name: service_account_code
      required: false
      schema:
        type: string
    rowFilter.api_keys.service_account_name:
      in: query
      name: service_account_name
      required: false
      schema:
        type: string
    rowFilter.api_keys.scopes:
      in: query
      name: scopes
      required: false
      schema:
        type: string
    rowFilter.api_keys.is_narrowed:
      in: query
      name: is_narrowed
      required: false
      schema:
        type: string
    rowFilter.api_keys.reader_id:
      in: query
      name: reader_id
      required: false
      schema:
        type: string
    rowFilter.api_keys.reader_code:
      in: query
      name: reader_code
      required: false
      schema:
        type: string
    rowFilter.api_keys.expires_at:
      in: query
      name: expires_at
      required: false
      schema:
        type: string
    rowFilter.api_keys.status:
      in: query
      name: status
      required: false
      schema:
        type: string
    rowFilter.api_keys.last_used_at:
      in: query
      name: last_used_at
      required: false
      schema:
        type: string
    rowFilter.api_keys.never_used:
      in: query
      name: never_used
      required: false
      schema:
        type: string
    rowFilter.api_keys.revoked_at:
      in: query
      name: revoked_at
      required: false
      schema:
        type: string
    rowFilter.api_keys.revoked_reason:
      in: query
      name: revoked_reason
      required: false
      schema:
        type: string
    rowFilter.api_keys.revoked_by_name:
      in: query
      name: revoked_by_name
      required: false
      schema:
        type: string
    rowFilter.api_keys.superseded_at:
      in: query
      name: superseded_at
      required: false
      schema:
        type: string
    rowFilter.api_keys.rotated_from_id:
      in: query
      name: rotated_from_id
      required: false
      schema:
        type: string
    rowFilter.api_keys.rotated_from_prefix:
      in: query
      name: rotated_from_prefix
      required: false
      schema:
        type: string
    rowFilter.api_keys.successor_id:
      in: query
      name: successor_id
      required: false
      schema:
        type: string
    rowFilter.api_keys.successor_prefix:
      in: query
      name: successor_prefix
      required: false
      schema:
        type: string
    rowFilter.api_keys.exchanges_7d:
      in: query
      name: exchanges_7d
      required: false
      schema:
        type: string
    rowFilter.api_keys.refusals_7d:
      in: query
      name: refusals_7d
      required: false
      schema:
        type: string
    rowFilter.api_keys.created_at:
      in: query
      name: created_at
      required: false
      schema:
        type: string
    rowFilter.api_keys.created_by_name:
      in: query
      name: created_by_name
      required: false
      schema:
        type: string
    rowFilter.api_keys.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:
    api_keys:
      description: >-
        Every key this organisation has issued — its prefix, its scopes, its
        state and what it has

        been used for. Never the key: it exists in one place, and that place is
        wherever the person who

        was shown it once put it.
      properties:
        created_at:
          format: timestamp with time zone
          type: string
        created_by_name:
          format: character varying
          maxLength: 200
          type: string
        exchanges_7d:
          format: bigint
          type: integer
        expires_at:
          format: timestamp with time zone
          type: string
        id:
          format: uuid
          type: string
        is_narrowed:
          format: boolean
          type: boolean
        key_prefix:
          format: character varying
          maxLength: 20
          type: string
        last_used_at:
          format: timestamp with time zone
          type: string
        name:
          format: character varying
          maxLength: 150
          type: string
        never_used:
          format: boolean
          type: boolean
        reader_code:
          format: character varying
          maxLength: 60
          type: string
        reader_id:
          description: >-
            Note:

            This is a Foreign Key to `readers.id`.<fk table='readers'
            column='id'/>
          format: uuid
          type: string
        refusals_7d:
          format: bigint
          type: integer
        revoked_at:
          format: timestamp with time zone
          type: string
        revoked_by_name:
          format: character varying
          maxLength: 200
          type: string
        revoked_reason:
          format: character varying
          maxLength: 200
          type: string
        rotated_from_id:
          description: >-
            Note:

            This is a Foreign Key to `api_keys.id`.<fk table='api_keys'
            column='id'/>
          format: uuid
          type: string
        rotated_from_prefix:
          format: character varying
          maxLength: 20
          type: string
        row_version:
          format: bigint
          type: integer
        scopes:
          format: text[]
          items:
            type: string
          type: array
        service_account_code:
          format: character varying
          maxLength: 60
          type: string
        service_account_id:
          description: >-
            Note:

            This is a Foreign Key to `service_accounts.id`.<fk
            table='service_accounts' column='id'/>
          format: uuid
          type: string
        service_account_name:
          format: character varying
          maxLength: 150
          type: string
        status:
          format: text
          type: string
        successor_id:
          description: |-
            Note:
            This is a Primary Key.<pk/>
          format: uuid
          type: string
        successor_prefix:
          format: character varying
          maxLength: 20
          type: string
        superseded_at:
          format: timestamp with time zone
          type: string
      type: object

````