api-docs.garmatsprayboothcustomers.com Open in urlscan Pro
2606:4700:10::6816:4e46  Public Scan

Form analysis
1 forms found in the DOM

GET https://api-docs.garmatsprayboothcustomers.com/search.json

<form class="simple_form doc-search__form" data-action="ajax:success->doc-search#onPostSuccess ajax:error->doc-search#onPostError ajax:beforeSend->doc-search#onBeforeSend" data-doc-search-target="form"
  action="https://api-docs.garmatsprayboothcustomers.com/search.json" accept-charset="UTF-8" data-remote="true" method="get">
  <svg width="14" height="14" fill="none" xmlns="http://www.w3.org/2000/svg" data-doc-search-target="searchIcon">
    <path d="m13 13-3-3M6.143 11.286A5.143 5.143 0 1 0 6.143 1a5.143 5.143 0 0 0 0 10.286Z" stroke="currentColor" stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round"></path>
  </svg>
  <div class="loader doc-search__loader" aria-label="Loading" aria-live="assertive" aria-hidden="true" data-loader-type="bars" data-doc-search-target="loader"></div>
  <input label="false" autocomplete="off" type="hidden" name="uid" id="uid" value="0.badc6c3256f76">
  <input label="false" autocomplete="off" autofocus="autofocus" data-doc-search-target="input" data-action="input->doc-search#submitOnType" class="string required" required="required" aria-required="true" placeholder="Search" type="text" name="query"
    id="query">
  <button type="button" class="esc-button" data-action="click->dialog#close">ESC</button>
</form>

Text Content

Garmat API Show Menu
Search… Ctrl+K

ESC





Example searches: “Create a new account”, “400”, “limit”, “users”, “page”


Toggle dark mode

--------------------------------------------------------------------------------

 * API Changelog

--------------------------------------------------------------------------------

Download source
 * JSON OpenAPI specification
 * YAML OpenAPI specification


TOPICS

 * Introduction
 * Authentication


ENDPOINTS

 * Accounts
   * Retrieves the list of paginated accounts
     GET
   * Create a new account
     POST
   * Retrieves an account's details
     GET
   * Update an existing account
     PUT
 * Alert types
   * Gets the list of existing alert types in the system
     GET
   * Updates all alert types
     PUT
 * Alerts
   * Retrieves history of alerts in scope
     GET
 * Api keys
   * Retrieves the list of api_keys
     GET
   * Creates an API key associated with the currently logged in user account
     POST
   * Deletes the API key with the given id
     DELETE
 * Authenticate
   * Verifies a given API Key and authenticates the user
     POST
 * Booths
   * Retrieves the list of booths
     GET
   * Retrieves the last update for every booth the user has access to
     GET
   * Retrieves history of alerts for a booth
     GET
   * Retrieves a booth's details
     GET
   * Updates an existing booth
     PUT
   * Returns a list of modes with their duration of usage for the given booth
     and tag name between start and end times.
     GET
   * Exports Booth Data in CSV format
     GET
   * Returns a list of modes with their frequency of usage for the given booth
     and tag name between start and end times.
     GET
   * Retrieves historic tag data for a booth
     GET
   * Retrieves the latest values for a given set of tags for a specific booth
     GET
   * Retrieves recent stages for a booth
     GET
   * Returns duration of the given period and the immediate previous period and
     delta between them.
     GET
   * Returns the requested number of time buckets between the given date range
     with the total minutes of runtime for each.
     GET
 * Facilities
   * Retrieves the list of facilities
     GET
   * Creates a new facility
     POST
   * Retrieves the details of a facility
     GET
   * Updates a facility
     PUT
 * Login
   * Initiates a new login attempt
     POST
   * Verifies a given token and authenticates the user
     POST
 * Users
   * Retrieves the list of paginated users
     GET
   * Create a new user
     POST
   * Update an existing user
     PUT

Powered by Bump.sh
Dismiss highlight Show more

--------------------------------------------------------------------------------

--------------------------------------------------------------------------------

--------------------------------------------------------------------------------



--------------------------------------------------------------------------------




--------------------------------------------------------------------------------


GARMAT API
0.0.4

Base URL

http://localhost:4000

This is the documentation for version 0.0.4 of the API. Last update on Jun 20,
2024.


AUTHENTICATION


API KEY (HTTP_API_KEY)

Send an authentication token in the Authorization header to authenticate with
the API.


ACCOUNTS


RETRIEVES THE LIST OF PAGINATED ACCOUNTS

GET /api/accounts

RESPONSES

 * 200
   
   OK
   
   Hide response attributes Show response attributes object
    * data array[object]
      
      Accounts data
      
      Hide data attributes Show data attributes object
       * booths number
         
         Number of booths in the system associated to the account
      
       * facilities number
         
         Number of facilities in the system associated to the account
      
       * id string
         
         ID of the account in the system
      
       * name string
         
         Name of the account
      
       * status string
         
         Whether the account is active or has been deactivated
      
       * type string
         
         Account type
      
       * users number
         
         Number of users in the system associated to the account
   
    * 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/accounts

curl \
 -X GET http://localhost:4000/api/accounts \
 -H "Authorization: $API_KEY"

Response examples (200)

{
  "data": [
    {
      "name": "Test Account",
      "type": "customer",
      "users": 5,
      "booths": 2,
      "status": "active"
    }
  ],
  "page": 1,
  "limit": 1,
  "pages": 20,
  "total": 20
}

Response examples (200)

{
  "data": [
    {
      "name": "Test Account",
      "type": "customer",
      "users": 5,
      "booths": 2,
      "status": "active"
    }
  ],
  "page": 1,
  "limit": 1,
  "pages": 20,
  "total": 20
}

Response examples (401)

{
  "error": "Error Reason"
}

Response examples (401)

{
  "error": "Error Reason"
}