List booths

GET /api/booths

Allows you to retrieve a paginated list of booths under your account.

Query parameters

filter string

criteria to filter by
sort string

criteria to sort by
limit string

amount of results per page to return
page string

page number

Responses

200

OK
Hide response attributes Show response attributes object
- data array[object]
  
  Booth data
  
  Hide data attributes Show data attributes object
  
  account_name string
  
  Name of the facility 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
  
  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

Unauthorized
Hide response attribute Show response attribute object
- error string
  
  Human readable version of the error status code

GET /api/booths

curl \
 -X GET http://localhost:4000/api/booths

Response examples (200)

{
  "data": [],
  "page": 1,
  "limit": 25,
  "pages": 1,
  "total": 0
}

Response examples (200)

{
  "data": [],
  "page": 1,
  "limit": 25,
  "pages": 1,
  "total": 0
}

Response examples (401)

{
  "error": "Error Reason"
}

Response examples (401)

{
  "error": "Error Reason"
}