Query parameters

• filter string

  criteria to filter by

• sort string

  criteria to sort by

• search string

  criteria to search by

• limit string

  amount of results per page to return

• page string

  page number

• start string

  ISO8601 formatted datetime to include booth utilization data since

• includes string

  optional features to include. This is a list of values separated by colons ':'. The avaiable values are: cycle_count (adds cycles_count), utilization_times (adds utilization_minutes and working_minutes), energy_usage (adds kwh_usage and gas_usage), bake_time, and overuse_data (adds overuse_minutes and overuse_cycles)

• end string

  ISO8601 formated datetime to include booth utilization data until

Responses

• 200 application/json

  OK

  Hide response attributes Show response attributes object

  • data array[object]

    Booth data

    Hide data attributes Show data attributes object

    • account_id string

      Id of the account that the booth belongs to

    • account_name string

      Name of the account that the booth belongs to

    • bay_count string

      Number of bays on the booth

    • brand_name string

      Name of the booth's manufacturer

    • burner_size string

      Burner size of the booth (MBTU)

    • created_at string

      ISO8601 encoded timestamp when the booth was created

    • external_id string

      Client identifier of the booth

    • facility_id string

      ID of the facility that the booth belongs to

    • facility_name string

      Name of the facility that the booth belongs to

    • height string

      Height of the booth in ft

    • id string

      ID of the booth within the application

    • last_updated_at string

      ISO8601 encoded timestamp when last update was received

    • length string

      Length of the booth in ft

    • model_number string

      Model number of the booth

    • motor_size string

      Motor size of the booth (HP)

    • name string

      String name of the booth

    • plc_program string

      Current PLC program running on the booth

    • plc_program_revision string

      Current revision of the PLC program running on the booth

    • serial_number string

      Serial number of the booth

    • status string

      Whether the booth is active or has been decommissioned

    • total_runtime string

      Total runtime hours last reported by the PLC. Null if missing

    • width string

      Width of the booth in ft

  • limit number

    The number of items per page currently applied

  • page number

    The number of the page returned

  • pages number

    The total number of pages matching the current search

  • total number

    The total number of accounts matching the query

• 401 application/json

  Unauthorized

  Hide response attribute Show response attribute object

  • error string

    Human readable version of the error status code