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

# Readers with how they are reached, whether they are reaching us, and what is in front of them now.



## OpenAPI

````yaml /api-reference/openapi.json get /readers
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:
  /readers:
    get:
      tags:
        - Readers
      summary: >-
        Readers with how they are reached, whether they are reaching us, and
        what is in front of them now.
      parameters:
        - $ref: '#/components/parameters/rowFilter.readers.id'
        - $ref: '#/components/parameters/rowFilter.readers.device_id'
        - $ref: '#/components/parameters/rowFilter.readers.code'
        - $ref: '#/components/parameters/rowFilter.readers.name'
        - $ref: '#/components/parameters/rowFilter.readers.device_status'
        - $ref: '#/components/parameters/rowFilter.readers.device_last_seen_at'
        - $ref: '#/components/parameters/rowFilter.readers.site_id'
        - $ref: '#/components/parameters/rowFilter.readers.site_name'
        - $ref: '#/components/parameters/rowFilter.readers.serial_number'
        - $ref: '#/components/parameters/rowFilter.readers.firmware_version'
        - $ref: '#/components/parameters/rowFilter.readers.transport'
        - $ref: '#/components/parameters/rowFilter.readers.host'
        - $ref: '#/components/parameters/rowFilter.readers.port'
        - $ref: '#/components/parameters/rowFilter.readers.tls_mode'
        - $ref: '#/components/parameters/rowFilter.readers.verify_certificate'
        - $ref: '#/components/parameters/rowFilter.readers.username'
        - $ref: '#/components/parameters/rowFilter.readers.mqtt_topic_filter'
        - $ref: '#/components/parameters/rowFilter.readers.mqtt_client_id'
        - $ref: '#/components/parameters/rowFilter.readers.mqtt_qos'
        - $ref: '#/components/parameters/rowFilter.readers.payload_format'
        - $ref: '#/components/parameters/rowFilter.readers.payload_map'
        - $ref: '#/components/parameters/rowFilter.readers.tag_format'
        - $ref: '#/components/parameters/rowFilter.readers.read_interval_seconds'
        - $ref: '#/components/parameters/rowFilter.readers.max_reads_per_minute'
        - $ref: '#/components/parameters/rowFilter.readers.handover_rssi_margin'
        - $ref: '#/components/parameters/rowFilter.readers.clock_skew_minutes'
        - $ref: '#/components/parameters/rowFilter.readers.is_paused'
        - $ref: '#/components/parameters/rowFilter.readers.connection_state'
        - $ref: '#/components/parameters/rowFilter.readers.last_connected_at'
        - $ref: '#/components/parameters/rowFilter.readers.last_message_at'
        - $ref: '#/components/parameters/rowFilter.readers.last_error'
        - $ref: '#/components/parameters/rowFilter.readers.last_error_at'
        - $ref: '#/components/parameters/rowFilter.readers.consecutive_failures'
        - $ref: '#/components/parameters/rowFilter.readers.next_attempt_at'
        - $ref: '#/components/parameters/rowFilter.readers.last_payload'
        - $ref: '#/components/parameters/rowFilter.readers.last_payload_at'
        - $ref: '#/components/parameters/rowFilter.readers.unmapped_count'
        - $ref: '#/components/parameters/rowFilter.readers.last_unmapped_payload'
        - $ref: '#/components/parameters/rowFilter.readers.messages_received'
        - $ref: '#/components/parameters/rowFilter.readers.dropped_messages'
        - $ref: '#/components/parameters/rowFilter.readers.max_clock_skew_seconds'
        - $ref: '#/components/parameters/rowFilter.readers.claimed_by'
        - $ref: '#/components/parameters/rowFilter.readers.claimed_at'
        - $ref: '#/components/parameters/rowFilter.readers.has_credential'
        - $ref: '#/components/parameters/rowFilter.readers.credential_hint'
        - $ref: '#/components/parameters/rowFilter.readers.credential_set_at'
        - $ref: '#/components/parameters/rowFilter.readers.antennas'
        - $ref: '#/components/parameters/rowFilter.readers.present_now'
        - $ref: '#/components/parameters/rowFilter.readers.silent_antennas'
        - $ref: '#/components/parameters/rowFilter.readers.connected_but_silent'
        - $ref: '#/components/parameters/rowFilter.readers.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/readers'
                type: array
            application/vnd.pgrst.object+json:
              schema:
                items:
                  $ref: '#/components/schemas/readers'
                type: array
            application/vnd.pgrst.object+json;nulls=stripped:
              schema:
                items:
                  $ref: '#/components/schemas/readers'
                type: array
            text/csv:
              schema:
                items:
                  $ref: '#/components/schemas/readers'
                type: array
          description: OK
        '206':
          description: Partial Content
components:
  parameters:
    rowFilter.readers.id:
      in: query
      name: id
      required: false
      schema:
        type: string
    rowFilter.readers.device_id:
      in: query
      name: device_id
      required: false
      schema:
        type: string
    rowFilter.readers.code:
      in: query
      name: code
      required: false
      schema:
        type: string
    rowFilter.readers.name:
      in: query
      name: name
      required: false
      schema:
        type: string
    rowFilter.readers.device_status:
      in: query
      name: device_status
      required: false
      schema:
        type: string
    rowFilter.readers.device_last_seen_at:
      in: query
      name: device_last_seen_at
      required: false
      schema:
        type: string
    rowFilter.readers.site_id:
      in: query
      name: site_id
      required: false
      schema:
        type: string
    rowFilter.readers.site_name:
      in: query
      name: site_name
      required: false
      schema:
        type: string
    rowFilter.readers.serial_number:
      in: query
      name: serial_number
      required: false
      schema:
        type: string
    rowFilter.readers.firmware_version:
      in: query
      name: firmware_version
      required: false
      schema:
        type: string
    rowFilter.readers.transport:
      in: query
      name: transport
      required: false
      schema:
        type: string
    rowFilter.readers.host:
      in: query
      name: host
      required: false
      schema:
        type: string
    rowFilter.readers.port:
      in: query
      name: port
      required: false
      schema:
        type: string
    rowFilter.readers.tls_mode:
      in: query
      name: tls_mode
      required: false
      schema:
        type: string
    rowFilter.readers.verify_certificate:
      in: query
      name: verify_certificate
      required: false
      schema:
        type: string
    rowFilter.readers.username:
      in: query
      name: username
      required: false
      schema:
        type: string
    rowFilter.readers.mqtt_topic_filter:
      in: query
      name: mqtt_topic_filter
      required: false
      schema:
        type: string
    rowFilter.readers.mqtt_client_id:
      in: query
      name: mqtt_client_id
      required: false
      schema:
        type: string
    rowFilter.readers.mqtt_qos:
      in: query
      name: mqtt_qos
      required: false
      schema:
        type: string
    rowFilter.readers.payload_format:
      in: query
      name: payload_format
      required: false
      schema:
        type: string
    rowFilter.readers.payload_map:
      in: query
      name: payload_map
      required: false
      schema:
        type: string
    rowFilter.readers.tag_format:
      in: query
      name: tag_format
      required: false
      schema:
        type: string
    rowFilter.readers.read_interval_seconds:
      in: query
      name: read_interval_seconds
      required: false
      schema:
        type: string
    rowFilter.readers.max_reads_per_minute:
      in: query
      name: max_reads_per_minute
      required: false
      schema:
        type: string
    rowFilter.readers.handover_rssi_margin:
      in: query
      name: handover_rssi_margin
      required: false
      schema:
        type: string
    rowFilter.readers.clock_skew_minutes:
      in: query
      name: clock_skew_minutes
      required: false
      schema:
        type: string
    rowFilter.readers.is_paused:
      in: query
      name: is_paused
      required: false
      schema:
        type: string
    rowFilter.readers.connection_state:
      in: query
      name: connection_state
      required: false
      schema:
        type: string
    rowFilter.readers.last_connected_at:
      in: query
      name: last_connected_at
      required: false
      schema:
        type: string
    rowFilter.readers.last_message_at:
      in: query
      name: last_message_at
      required: false
      schema:
        type: string
    rowFilter.readers.last_error:
      in: query
      name: last_error
      required: false
      schema:
        type: string
    rowFilter.readers.last_error_at:
      in: query
      name: last_error_at
      required: false
      schema:
        type: string
    rowFilter.readers.consecutive_failures:
      in: query
      name: consecutive_failures
      required: false
      schema:
        type: string
    rowFilter.readers.next_attempt_at:
      in: query
      name: next_attempt_at
      required: false
      schema:
        type: string
    rowFilter.readers.last_payload:
      in: query
      name: last_payload
      required: false
      schema:
        type: string
    rowFilter.readers.last_payload_at:
      in: query
      name: last_payload_at
      required: false
      schema:
        type: string
    rowFilter.readers.unmapped_count:
      in: query
      name: unmapped_count
      required: false
      schema:
        type: string
    rowFilter.readers.last_unmapped_payload:
      in: query
      name: last_unmapped_payload
      required: false
      schema:
        type: string
    rowFilter.readers.messages_received:
      in: query
      name: messages_received
      required: false
      schema:
        type: string
    rowFilter.readers.dropped_messages:
      in: query
      name: dropped_messages
      required: false
      schema:
        type: string
    rowFilter.readers.max_clock_skew_seconds:
      in: query
      name: max_clock_skew_seconds
      required: false
      schema:
        type: string
    rowFilter.readers.claimed_by:
      in: query
      name: claimed_by
      required: false
      schema:
        type: string
    rowFilter.readers.claimed_at:
      in: query
      name: claimed_at
      required: false
      schema:
        type: string
    rowFilter.readers.has_credential:
      in: query
      name: has_credential
      required: false
      schema:
        type: string
    rowFilter.readers.credential_hint:
      in: query
      name: credential_hint
      required: false
      schema:
        type: string
    rowFilter.readers.credential_set_at:
      in: query
      name: credential_set_at
      required: false
      schema:
        type: string
    rowFilter.readers.antennas:
      in: query
      name: antennas
      required: false
      schema:
        type: string
    rowFilter.readers.present_now:
      in: query
      name: present_now
      required: false
      schema:
        type: string
    rowFilter.readers.silent_antennas:
      in: query
      name: silent_antennas
      required: false
      schema:
        type: string
    rowFilter.readers.connected_but_silent:
      in: query
      name: connected_but_silent
      required: false
      schema:
        type: string
    rowFilter.readers.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:
    readers:
      description: >-
        Readers with how they are reached, whether they are reaching us, and
        what is in front of them now.
      properties:
        antennas:
          format: bigint
          type: integer
        claimed_at:
          format: timestamp with time zone
          type: string
        claimed_by:
          format: character varying
          maxLength: 120
          type: string
        clock_skew_minutes:
          format: integer
          type: integer
        code:
          format: character varying
          maxLength: 60
          type: string
        connected_but_silent:
          format: boolean
          type: boolean
        connection_state:
          format: character varying
          maxLength: 20
          type: string
        consecutive_failures:
          format: integer
          type: integer
        credential_hint:
          format: character varying
          maxLength: 12
          type: string
        credential_set_at:
          format: timestamp with time zone
          type: string
        device_id:
          format: uuid
          type: string
        device_last_seen_at:
          format: timestamp with time zone
          type: string
        device_status:
          format: character varying
          maxLength: 20
          type: string
        dropped_messages:
          format: bigint
          type: integer
        firmware_version:
          format: character varying
          maxLength: 40
          type: string
        handover_rssi_margin:
          format: integer
          type: integer
        has_credential:
          format: boolean
          type: boolean
        host:
          format: character varying
          maxLength: 255
          type: string
        id:
          description: |-
            Note:
            This is a Primary Key.<pk/>
          format: uuid
          type: string
        is_paused:
          format: boolean
          type: boolean
        last_connected_at:
          format: timestamp with time zone
          type: string
        last_error:
          format: text
          type: string
        last_error_at:
          format: timestamp with time zone
          type: string
        last_message_at:
          format: timestamp with time zone
          type: string
        last_payload:
          format: jsonb
        last_payload_at:
          format: timestamp with time zone
          type: string
        last_unmapped_payload:
          format: text
          type: string
        max_clock_skew_seconds:
          format: integer
          type: integer
        max_reads_per_minute:
          format: integer
          type: integer
        messages_received:
          format: bigint
          type: integer
        mqtt_client_id:
          format: character varying
          maxLength: 120
          type: string
        mqtt_qos:
          format: smallint
          type: integer
        mqtt_topic_filter:
          format: character varying
          maxLength: 500
          type: string
        name:
          format: character varying
          maxLength: 150
          type: string
        next_attempt_at:
          format: timestamp with time zone
          type: string
        payload_format:
          format: character varying
          maxLength: 20
          type: string
        payload_map:
          format: jsonb
        port:
          format: integer
          type: integer
        present_now:
          format: bigint
          type: integer
        read_interval_seconds:
          format: integer
          type: integer
        row_version:
          format: bigint
          type: integer
        serial_number:
          format: character varying
          maxLength: 80
          type: string
        silent_antennas:
          format: bigint
          type: integer
        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
        tag_format:
          format: character varying
          maxLength: 20
          type: string
        tls_mode:
          format: character varying
          maxLength: 20
          type: string
        transport:
          format: character varying
          maxLength: 20
          type: string
        unmapped_count:
          format: bigint
          type: integer
        username:
          format: character varying
          maxLength: 320
          type: string
        verify_certificate:
          format: boolean
          type: boolean
      type: object

````