> ## 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 statuses each register can be in, with how the screens should draw them. display_name is as authored, for the…

> The statuses each register can be in, with how the screens should draw them. display_name is as authored, for the screen that edits it; shown_display_name is as the reader reads it. in_reach is false for an asset status the caller's roles do not grant, so a filter or a picker can leave out a status whose assets the caller cannot see.



## OpenAPI

````yaml /api-reference/openapi.json get /state_settings
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: My work
  - name: Sites and locations
  - name: Assets
  - name: Asset lifecycle
  - name: Asset components
  - name: Work lifecycle
  - name: Work order execution
  - name: Work sequencing
  - name: Maintenance
  - name: Inspections
  - name: Checklists
  - name: Verification
  - name: Self verification
  - name: Inventory
  - name: Inventory detail
  - name: Parts demand
  - name: Procurement
  - name: Vendors and contracts
  - name: Contracts
  - name: Amendments
  - name: Vendor spend forecast
  - name: Workforce
  - name: Workforce detail
  - name: Capacity
  - name: Dispatch
  - name: Shutdown
  - name: Permits
  - name: Tools
  - name: Tools on jobs
  - name: Bookings
  - name: Calibration history
  - name: Reliability
  - name: Sensors and meters
  - name: Readers
  - name: Trackers
  - name: Real-time location
  - name: Feeds
  - name: Energy
  - name: IT assets
  - name: IT asset software
  - name: IT asset topology
  - name: Map
  - name: Floor plans
  - name: Labels
  - name: Lost and found
  - name: Visitors
  - name: Root cause analysis
  - name: Costing
  - name: Finance
  - name: Budgets
  - name: Capex plans
  - name: FF&E plans
  - name: Documents
  - name: Document control
  - name: Document folders
  - name: Document tree
  - name: Knowledge
  - name: Reports
  - name: Dashboards
  - name: Extracts
  - name: Data exports
  - name: Audit center
  - name: Audit feed
  - name: Activity
  - name: Conversations
  - name: Notifications
  - name: Date reminders
  - name: Channels
  - name: Search
  - name: Copilot
  - name: Import
  - name: Bulk jobs
  - name: File exchange
  - name: Filing exceptions
  - name: Files
  - name: Sync
  - name: Support
  - name: API keys
  - name: Webhooks
  - name: MCP connections
  - name: MCP sign-in
  - name: SCIM provisioning
  - name: Directory sync
  - name: Security streams
  - name: Single sign-on
  - name: Two-factor sign-in
  - name: Admin
  - name: Access
  - name: Lookups
  - name: Read models
  - name: Reference
  - name: Reference columns
  - name: Reference entry
  - name: List views
  - name: Mapping
  - name: Numbering
  - name: Branding
  - name: Custom fields
  - name: Form studio
  - name: Workflows
  - name: Workflow studio
  - name: Rules
  - name: Statuses and transitions
  - name: Currencies and locales
  - name: Today
  - 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: Setup
  - name: Features
  - name: Billing
  - name: Licence
  - name: Welcome
  - name: Tray
  - name: Tenant switch
  - name: Release
  - name: Telegram
  - name: Inbound mail
  - name: Platform
externalDocs:
  description: PostgREST Documentation
  url: https://postgrest.org/en/v12/references/api.html
paths:
  /state_settings:
    get:
      tags:
        - Statuses and transitions
      summary: >-
        The statuses each register can be in, with how the screens should draw
        them. display_name is as authored, for the…
      description: >-
        The statuses each register can be in, with how the screens should draw
        them. display_name is as authored, for the screen that edits it;
        shown_display_name is as the reader reads it. in_reach is false for an
        asset status the caller's roles do not grant, so a filter or a picker
        can leave out a status whose assets the caller cannot see.
      parameters:
        - $ref: '#/components/parameters/rowFilter.state_settings.id'
        - $ref: '#/components/parameters/rowFilter.state_settings.entity_type'
        - $ref: '#/components/parameters/rowFilter.state_settings.state_model_id'
        - $ref: >-
            #/components/parameters/rowFilter.state_settings.state_model_version_id
        - $ref: >-
            #/components/parameters/rowFilter.state_settings.state_model_is_default
        - $ref: '#/components/parameters/rowFilter.state_settings.in_running_version'
        - $ref: '#/components/parameters/rowFilter.state_settings.code'
        - $ref: '#/components/parameters/rowFilter.state_settings.display_name'
        - $ref: '#/components/parameters/rowFilter.state_settings.shown_display_name'
        - $ref: '#/components/parameters/rowFilter.state_settings.category'
        - $ref: '#/components/parameters/rowFilter.state_settings.color'
        - $ref: '#/components/parameters/rowFilter.state_settings.icon'
        - $ref: '#/components/parameters/rowFilter.state_settings.sort_order'
        - $ref: '#/components/parameters/rowFilter.state_settings.is_active'
        - $ref: '#/components/parameters/rowFilter.state_settings.is_initial'
        - $ref: '#/components/parameters/rowFilter.state_settings.allows_creation'
        - $ref: '#/components/parameters/rowFilter.state_settings.is_terminal'
        - $ref: '#/components/parameters/rowFilter.state_settings.counts_as_open'
        - $ref: '#/components/parameters/rowFilter.state_settings.counts_as_active'
        - $ref: '#/components/parameters/rowFilter.state_settings.counts_as_downtime'
        - $ref: '#/components/parameters/rowFilter.state_settings.counts_as_accepted'
        - $ref: '#/components/parameters/rowFilter.state_settings.counts_as_assigned'
        - $ref: '#/components/parameters/rowFilter.state_settings.counts_as_disposed'
        - $ref: '#/components/parameters/rowFilter.state_settings.requires_custodian'
        - $ref: '#/components/parameters/rowFilter.state_settings.stops_sla'
        - $ref: '#/components/parameters/rowFilter.state_settings.pauses_sla'
        - $ref: >-
            #/components/parameters/rowFilter.state_settings.allows_technician_edit
        - $ref: >-
            #/components/parameters/rowFilter.state_settings.allows_parts_consumption
        - $ref: '#/components/parameters/rowFilter.state_settings.allows_labour_entry'
        - $ref: '#/components/parameters/rowFilter.state_settings.allows_attachments'
        - $ref: '#/components/parameters/rowFilter.state_settings.allows_reschedule'
        - $ref: >-
            #/components/parameters/rowFilter.state_settings.allows_sla_extension
        - $ref: '#/components/parameters/rowFilter.state_settings.auto_check_in'
        - $ref: '#/components/parameters/rowFilter.state_settings.auto_check_out'
        - $ref: '#/components/parameters/rowFilter.state_settings.offline_allowed'
        - $ref: '#/components/parameters/rowFilter.state_settings.in_reach'
        - $ref: '#/components/parameters/rowFilter.state_settings.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/state_settings'
                type: array
            application/vnd.pgrst.object+json:
              schema:
                items:
                  $ref: '#/components/schemas/state_settings'
                type: array
            application/vnd.pgrst.object+json;nulls=stripped:
              schema:
                items:
                  $ref: '#/components/schemas/state_settings'
                type: array
            text/csv:
              schema:
                items:
                  $ref: '#/components/schemas/state_settings'
                type: array
          description: OK
        '206':
          description: Partial Content
components:
  parameters:
    rowFilter.state_settings.id:
      in: query
      name: id
      required: false
      schema:
        type: string
    rowFilter.state_settings.entity_type:
      in: query
      name: entity_type
      required: false
      schema:
        type: string
    rowFilter.state_settings.state_model_id:
      in: query
      name: state_model_id
      required: false
      schema:
        type: string
    rowFilter.state_settings.state_model_version_id:
      in: query
      name: state_model_version_id
      required: false
      schema:
        type: string
    rowFilter.state_settings.state_model_is_default:
      in: query
      name: state_model_is_default
      required: false
      schema:
        type: string
    rowFilter.state_settings.in_running_version:
      in: query
      name: in_running_version
      required: false
      schema:
        type: string
    rowFilter.state_settings.code:
      in: query
      name: code
      required: false
      schema:
        type: string
    rowFilter.state_settings.display_name:
      in: query
      name: display_name
      required: false
      schema:
        type: string
    rowFilter.state_settings.shown_display_name:
      in: query
      name: shown_display_name
      required: false
      schema:
        type: string
    rowFilter.state_settings.category:
      in: query
      name: category
      required: false
      schema:
        type: string
    rowFilter.state_settings.color:
      in: query
      name: color
      required: false
      schema:
        type: string
    rowFilter.state_settings.icon:
      in: query
      name: icon
      required: false
      schema:
        type: string
    rowFilter.state_settings.sort_order:
      in: query
      name: sort_order
      required: false
      schema:
        type: string
    rowFilter.state_settings.is_active:
      in: query
      name: is_active
      required: false
      schema:
        type: string
    rowFilter.state_settings.is_initial:
      in: query
      name: is_initial
      required: false
      schema:
        type: string
    rowFilter.state_settings.allows_creation:
      in: query
      name: allows_creation
      required: false
      schema:
        type: string
    rowFilter.state_settings.is_terminal:
      in: query
      name: is_terminal
      required: false
      schema:
        type: string
    rowFilter.state_settings.counts_as_open:
      in: query
      name: counts_as_open
      required: false
      schema:
        type: string
    rowFilter.state_settings.counts_as_active:
      in: query
      name: counts_as_active
      required: false
      schema:
        type: string
    rowFilter.state_settings.counts_as_downtime:
      in: query
      name: counts_as_downtime
      required: false
      schema:
        type: string
    rowFilter.state_settings.counts_as_accepted:
      in: query
      name: counts_as_accepted
      required: false
      schema:
        type: string
    rowFilter.state_settings.counts_as_assigned:
      in: query
      name: counts_as_assigned
      required: false
      schema:
        type: string
    rowFilter.state_settings.counts_as_disposed:
      in: query
      name: counts_as_disposed
      required: false
      schema:
        type: string
    rowFilter.state_settings.requires_custodian:
      in: query
      name: requires_custodian
      required: false
      schema:
        type: string
    rowFilter.state_settings.stops_sla:
      in: query
      name: stops_sla
      required: false
      schema:
        type: string
    rowFilter.state_settings.pauses_sla:
      in: query
      name: pauses_sla
      required: false
      schema:
        type: string
    rowFilter.state_settings.allows_technician_edit:
      in: query
      name: allows_technician_edit
      required: false
      schema:
        type: string
    rowFilter.state_settings.allows_parts_consumption:
      in: query
      name: allows_parts_consumption
      required: false
      schema:
        type: string
    rowFilter.state_settings.allows_labour_entry:
      in: query
      name: allows_labour_entry
      required: false
      schema:
        type: string
    rowFilter.state_settings.allows_attachments:
      in: query
      name: allows_attachments
      required: false
      schema:
        type: string
    rowFilter.state_settings.allows_reschedule:
      in: query
      name: allows_reschedule
      required: false
      schema:
        type: string
    rowFilter.state_settings.allows_sla_extension:
      in: query
      name: allows_sla_extension
      required: false
      schema:
        type: string
    rowFilter.state_settings.auto_check_in:
      in: query
      name: auto_check_in
      required: false
      schema:
        type: string
    rowFilter.state_settings.auto_check_out:
      in: query
      name: auto_check_out
      required: false
      schema:
        type: string
    rowFilter.state_settings.offline_allowed:
      in: query
      name: offline_allowed
      required: false
      schema:
        type: string
    rowFilter.state_settings.in_reach:
      in: query
      name: in_reach
      required: false
      schema:
        type: string
    rowFilter.state_settings.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:
    state_settings:
      description: >-
        The statuses each register can be in, with how the screens should draw
        them. display_name is as authored, for the screen that edits it;
        shown_display_name is as the reader reads it. in_reach is false for an
        asset status the caller's roles do not grant, so a filter or a picker
        can leave out a status whose assets the caller cannot see.
      properties:
        allows_attachments:
          format: boolean
          type: boolean
        allows_creation:
          format: boolean
          type: boolean
        allows_labour_entry:
          format: boolean
          type: boolean
        allows_parts_consumption:
          format: boolean
          type: boolean
        allows_reschedule:
          format: boolean
          type: boolean
        allows_sla_extension:
          format: boolean
          type: boolean
        allows_technician_edit:
          format: boolean
          type: boolean
        auto_check_in:
          format: boolean
          type: boolean
        auto_check_out:
          format: boolean
          type: boolean
        category:
          format: character varying
          maxLength: 20
          type: string
        code:
          format: character varying
          maxLength: 60
          type: string
        color:
          format: character varying
          maxLength: 20
          type: string
        counts_as_accepted:
          format: boolean
          type: boolean
        counts_as_active:
          format: boolean
          type: boolean
        counts_as_assigned:
          format: boolean
          type: boolean
        counts_as_disposed:
          format: boolean
          type: boolean
        counts_as_downtime:
          format: boolean
          type: boolean
        counts_as_open:
          format: boolean
          type: boolean
        display_name:
          format: character varying
          maxLength: 150
          type: string
        entity_type:
          format: character varying
          maxLength: 80
          type: string
        icon:
          format: character varying
          maxLength: 60
          type: string
        id:
          description: |-
            Note:
            This is a Primary Key.<pk/>
          format: uuid
          type: string
        in_reach:
          format: boolean
          type: boolean
        in_running_version:
          format: boolean
          type: boolean
        is_active:
          format: boolean
          type: boolean
        is_initial:
          format: boolean
          type: boolean
        is_terminal:
          format: boolean
          type: boolean
        offline_allowed:
          format: boolean
          type: boolean
        pauses_sla:
          format: boolean
          type: boolean
        requires_custodian:
          format: boolean
          type: boolean
        row_version:
          format: bigint
          type: integer
        shown_display_name:
          format: text
          type: string
        sort_order:
          format: integer
          type: integer
        state_model_id:
          description: |-
            Note:
            This is a Primary Key.<pk/>
          format: uuid
          type: string
        state_model_is_default:
          format: boolean
          type: boolean
        state_model_version_id:
          description: >-
            Note:

            This is a Foreign Key to `state_models.version_id`.<fk
            table='state_models' column='version_id'/>
          format: uuid
          type: string
        stops_sla:
          format: boolean
          type: boolean
      type: object

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.