# Garmat API ## Description This is version `0.0.4` of this API documentation. Last update on Oct 29, 2025. Garmat API allows you to interact with multiple resources of the GDX platform. This documentation provides a full picture of the available routes, resources, roles, and responses that might be seen when interacting with the API. It also includes a glossary of terms that might not be familiar to everyone. ## Servers - http://localhost:4000: http://localhost:4000 () ## Authentication ## Topics - [Getting Started](https://api-docs.garmatsprayboothcustomers.com/topic/topic-getting-started.md) - [Glossary](https://api-docs.garmatsprayboothcustomers.com/topic/topic-glossary.md) - [Rate Limiting](https://api-docs.garmatsprayboothcustomers.com/topic/topic-rate-limiting.md) - [Troubleshooting](https://api-docs.garmatsprayboothcustomers.com/topic/topic-troubleshooting.md) ## Endpoints and operations ### [Accounts](https://api-docs.garmatsprayboothcustomers.com/group/endpoint-accounts.md) - [List accounts](https://api-docs.garmatsprayboothcustomers.com/operation/operation-garmatapiweb-accountcontroller-index.md) - [Create an account](https://api-docs.garmatsprayboothcustomers.com/operation/operation-garmatapiweb-accountcontroller-create.md) - [summary of accounts and booths](https://api-docs.garmatsprayboothcustomers.com/operation/operation-garmatapiweb-accountcontroller-entities_summary.md) - [Get an account](https://api-docs.garmatsprayboothcustomers.com/operation/operation-garmatapiweb-accountcontroller-show.md) - [Update an existing account](https://api-docs.garmatsprayboothcustomers.com/operation/operation-garmatapiweb-accountcontroller-update.md) ### [Alert Types](https://api-docs.garmatsprayboothcustomers.com/group/endpoint-alert-types.md) - [List alert types](https://api-docs.garmatsprayboothcustomers.com/operation/operation-garmatapiweb-alerttypecontroller-index.md) - [Update alert types](https://api-docs.garmatsprayboothcustomers.com/operation/operation-garmatapiweb-alerttypecontroller-update_all.md) ### [Alerts](https://api-docs.garmatsprayboothcustomers.com/group/endpoint-alerts.md) - [Get history of alerts](https://api-docs.garmatsprayboothcustomers.com/operation/operation-garmatapiweb-alertcontroller-index.md) - [List alerts for a booth](https://api-docs.garmatsprayboothcustomers.com/operation/operation-garmatapiweb-alertcontroller-booth_index.md) ### [API Keys](https://api-docs.garmatsprayboothcustomers.com/group/endpoint-api-keys.md) - [Delete API key](https://api-docs.garmatsprayboothcustomers.com/operation/operation-garmatapiweb-apikeycontroller-delete.md) - [List API keys](https://api-docs.garmatsprayboothcustomers.com/operation/operation-garmatapiweb-apikeycontroller-index.md) - [Create API key](https://api-docs.garmatsprayboothcustomers.com/operation/operation-garmatapiweb-apikeycontroller-create.md) ### [Events](https://api-docs.garmatsprayboothcustomers.com/group/endpoint-events.md) - [List event notifications](https://api-docs.garmatsprayboothcustomers.com/operation/operation-garmatapiweb-eventcontroller-notifications_index.md) - [Show notification detail](https://api-docs.garmatsprayboothcustomers.com/operation/operation-garmatapiweb-eventcontroller-notification_detail.md) - [Show notification event definition](https://api-docs.garmatsprayboothcustomers.com/operation/operation-garmatapiweb-eventcontroller-show_definition.md) - [Update an existing event definition](https://api-docs.garmatsprayboothcustomers.com/operation/operation-garmatapiweb-eventcontroller-update_definition.md) - [Delete an event definition](https://api-docs.garmatsprayboothcustomers.com/operation/operation-garmatapiweb-eventcontroller-delete_definition.md) - [Update notification with allowed changes](https://api-docs.garmatsprayboothcustomers.com/operation/operation-garmatapiweb-eventcontroller-update_notification.md) - [List notification event definitions](https://api-docs.garmatsprayboothcustomers.com/operation/operation-garmatapiweb-eventcontroller-definitions_index.md) - [Create a new event definition](https://api-docs.garmatsprayboothcustomers.com/operation/operation-garmatapiweb-eventcontroller-create_definition.md) - [Mark all user's notifications as read](https://api-docs.garmatsprayboothcustomers.com/operation/operation-garmatapiweb-eventcontroller-mark_all_as_read.md) ### [Login](https://api-docs.garmatsprayboothcustomers.com/group/endpoint-login.md) - [Authenticate using an API Key](https://api-docs.garmatsprayboothcustomers.com/operation/operation-garmatapiweb-logincontroller-authenticate.md) - [Gets the user details of the user making the request](https://api-docs.garmatsprayboothcustomers.com/operation/operation-garmatapiweb-logincontroller-profile.md) - [Verify a magic link token](https://api-docs.garmatsprayboothcustomers.com/operation/operation-garmatapiweb-logincontroller-verify.md) - [Initiate login attempt](https://api-docs.garmatsprayboothcustomers.com/operation/operation-garmatapiweb-logincontroller-create.md) ### [Booths](https://api-docs.garmatsprayboothcustomers.com/group/endpoint-booths.md) - [Get utilization timeline](https://api-docs.garmatsprayboothcustomers.com/operation/operation-garmatapiweb-boothcontroller-utilization_timeline.md) - [Get modes frequency](https://api-docs.garmatsprayboothcustomers.com/operation/operation-garmatapiweb-boothcontroller-frequency_by_mode.md) - [Export booth data](https://api-docs.garmatsprayboothcustomers.com/operation/operation-garmatapiweb-boothcontroller-export_csv.md) - [Get a summary per filter type for the booth.](https://api-docs.garmatsprayboothcustomers.com/operation/operation-garmatapiweb-boothcontroller-filter_maintenances.md) - [Get booth's latest values for tags](https://api-docs.garmatsprayboothcustomers.com/operation/operation-garmatapiweb-boothcontroller-latest_values_for.md) - [Get all booths' last updates](https://api-docs.garmatsprayboothcustomers.com/operation/operation-garmatapiweb-boothcontroller-latest_updates.md) - [Get utilization stats](https://api-docs.garmatsprayboothcustomers.com/operation/operation-garmatapiweb-boothcontroller-utilization_stats.md) - [Get tag history for a booth](https://api-docs.garmatsprayboothcustomers.com/operation/operation-garmatapiweb-boothcontroller-history.md) - [List booths](https://api-docs.garmatsprayboothcustomers.com/operation/operation-garmatapiweb-boothcontroller-index.md) - [Get the historic log of filter maintenances for a booth.](https://api-docs.garmatsprayboothcustomers.com/operation/operation-garmatapiweb-boothcontroller-filter_maintenance_history.md) - [Get booth revision history](https://api-docs.garmatsprayboothcustomers.com/operation/operation-garmatapiweb-boothcontroller-revision_history.md) - [Get utilization summary](https://api-docs.garmatsprayboothcustomers.com/operation/operation-garmatapiweb-boothcontroller-utilization_summary.md) - [Returns a map with filter options and their possible values](https://api-docs.garmatsprayboothcustomers.com/operation/operation-garmatapiweb-boothcontroller-booth_filter_options.md) - [Get booth by id](https://api-docs.garmatsprayboothcustomers.com/operation/operation-garmatapiweb-boothcontroller-show.md) - [Update booth](https://api-docs.garmatsprayboothcustomers.com/operation/operation-garmatapiweb-boothcontroller-update.md) - [Get historic runtime](https://api-docs.garmatsprayboothcustomers.com/operation/operation-garmatapiweb-boothcontroller-runtime_series.md) - [Get booth recent stages](https://api-docs.garmatsprayboothcustomers.com/operation/operation-garmatapiweb-boothcontroller-recent_stages.md) - [Get modes duration](https://api-docs.garmatsprayboothcustomers.com/operation/operation-garmatapiweb-boothcontroller-duration_by_mode.md) - [Get booth runtime](https://api-docs.garmatsprayboothcustomers.com/operation/operation-garmatapiweb-boothcontroller-runtime.md) - [Get booth's latest values for tags at a given timestamp](https://api-docs.garmatsprayboothcustomers.com/operation/operation-garmatapiweb-boothcontroller-latest_values_at.md) ### [Facilities](https://api-docs.garmatsprayboothcustomers.com/group/endpoint-facilities.md) - [Get facility utilization timeline](https://api-docs.garmatsprayboothcustomers.com/operation/operation-garmatapiweb-facilitycontroller-utilization_timeline.md) - [List facilities](https://api-docs.garmatsprayboothcustomers.com/operation/operation-garmatapiweb-facilitycontroller-index.md) - [Create a facility](https://api-docs.garmatsprayboothcustomers.com/operation/operation-garmatapiweb-facilitycontroller-create.md) - [Get frequency utilization resume of all booths in Facility](https://api-docs.garmatsprayboothcustomers.com/operation/operation-garmatapiweb-facilitycontroller-utilization_frequency.md) - [Get facility details](https://api-docs.garmatsprayboothcustomers.com/operation/operation-garmatapiweb-facilitycontroller-show.md) - [Update a facility](https://api-docs.garmatsprayboothcustomers.com/operation/operation-garmatapiweb-facilitycontroller-update.md) - [Get facility utilization summary](https://api-docs.garmatsprayboothcustomers.com/operation/operation-garmatapiweb-facilitycontroller-utilization_summary.md) - [Get utilization resume of all booths in Facility](https://api-docs.garmatsprayboothcustomers.com/operation/operation-garmatapiweb-facilitycontroller-utilization.md) ### [Regions](https://api-docs.garmatsprayboothcustomers.com/group/endpoint-regions.md) - [Update a region](https://api-docs.garmatsprayboothcustomers.com/operation/operation-garmatapiweb-regioncontroller-update.md) - [Delete Region](https://api-docs.garmatsprayboothcustomers.com/operation/operation-garmatapiweb-regioncontroller-delete.md) - [List regions](https://api-docs.garmatsprayboothcustomers.com/operation/operation-garmatapiweb-regioncontroller-index.md) - [Create a region](https://api-docs.garmatsprayboothcustomers.com/operation/operation-garmatapiweb-regioncontroller-create.md) ### [Users](https://api-docs.garmatsprayboothcustomers.com/group/endpoint-users.md) - [Re-send user invitation](https://api-docs.garmatsprayboothcustomers.com/operation/operation-garmatapiweb-usercontroller-resend_invitation.md) - [Submit a help form](https://api-docs.garmatsprayboothcustomers.com/operation/operation-garmatapiweb-usercontroller-help.md) - [List users](https://api-docs.garmatsprayboothcustomers.com/operation/operation-garmatapiweb-usercontroller-index.md) - [Create user](https://api-docs.garmatsprayboothcustomers.com/operation/operation-garmatapiweb-usercontroller-create.md) - [Update user](https://api-docs.garmatsprayboothcustomers.com/operation/operation-garmatapiweb-usercontroller-update.md) - [Request a password change email](https://api-docs.garmatsprayboothcustomers.com/operation/operation-garmatapiweb-usercontroller-change_password.md) - [Update user invitation](https://api-docs.garmatsprayboothcustomers.com/operation/operation-garmatapiweb-usercontroller-update_invitation.md) ### [Filters](https://api-docs.garmatsprayboothcustomers.com/group/endpoint-filters.md) - [Get the trend of time in overuse](https://api-docs.garmatsprayboothcustomers.com/operation/operation-garmatapiweb-filtercontroller-overuse_trend.md) - [Get the historic log of filter maintenances for all booths in scope.](https://api-docs.garmatsprayboothcustomers.com/operation/operation-garmatapiweb-filtercontroller-maintenance_history.md) - [Get a timeline of utilization crossed with maintenance events information.](https://api-docs.garmatsprayboothcustomers.com/operation/operation-garmatapiweb-filtercontroller-maintenance_timeline.md) - [get a summary of filter services per booth](https://api-docs.garmatsprayboothcustomers.com/operation/operation-garmatapiweb-filtercontroller-services.md) ### [PLC Provisioning](https://api-docs.garmatsprayboothcustomers.com/group/endpoint-plc-provisioning.md) - [Create a booth provisioning data entry](https://api-docs.garmatsprayboothcustomers.com/operation/operation-garmatapiweb-provisioningcontroller-create.md) - [Retrieve a booth's provisioning data](https://api-docs.garmatsprayboothcustomers.com/operation/operation-garmatapiweb-provisioningcontroller-show.md) - [Update a booth's provisioning data](https://api-docs.garmatsprayboothcustomers.com/operation/operation-garmatapiweb-provisioningcontroller-update.md) ### [Utilization](https://api-docs.garmatsprayboothcustomers.com/group/endpoint-utilization.md) - [Get the utilization of all booths within scope](https://api-docs.garmatsprayboothcustomers.com/operation/operation-garmatapiweb-utilizationcontroller-utilization.md) - [Get the bucketed utilization of all booths within scope](https://api-docs.garmatsprayboothcustomers.com/operation/operation-garmatapiweb-utilizationcontroller-bucketed_utilization.md) - [Get utilization trends](https://api-docs.garmatsprayboothcustomers.com/operation/operation-garmatapiweb-utilizationcontroller-trends.md) ### [Reports](https://api-docs.garmatsprayboothcustomers.com/group/endpoint-reports.md) - [Get a cycles vs in use time report](https://api-docs.garmatsprayboothcustomers.com/operation/operation-garmatapiweb-reportcontroller-cycles_utilization.md) [Powered by Bump.sh](https://bump.sh)