For AI agents: the docs index is at https://docs.things5.com/llms.txt. Append .md to any documentation page URL to get its markdown version.
Jump to Content
Home
Guides
API Reference
Changelog
v1.0
Log In
API Reference
Log In
v1.0
Home
Guides
API Reference
Changelog
Knowledge base
JUMP TO
Getting started
Welcome
General parameters
Permissions
Firewall
FAQ
Glossary
Connect a device
Pairing code: send the confirmation code
Pairing code: get the certificate
Connecting a device
Generate certificate (Things5 CA)
put
Share a certificate between devices
put
Generate certificate (AWS IoT, deprecated)
put
HTTP API
Authentication
Get access token (API integration)
External app integration via OAuth
Get access token (username and password, deprecated)
post
Refresh token
post
Token exchange
post
Organization
List
get
Detail Organization
get
Update organization
patch
Logo and favicon update
put
Devices
[DEPRECATED] Device list
get
Device list
get
Device details
get
Device create
post
Change machine model
post
Device update
patch
Users
List users
get
Create
post
Delete
del
Custom attribute values update
put
Device data
Data ingestion
post
States read
get
States read last value
get
Metrics read
get
Aggregated metrics
get
Events read
get
Parameters read
get
Parameters write
post
Request a data export
post
List a device's data exports
get
Get a data export
get
Download a data export
get
List your data exports in an organization
get
Get a device KPI
get
Event durations
get
State durations
get
Kpi list
get
Device kpis
get
Metrics chart
get
Device models
Device models list
get
Device model detail
get
Update
patch
Custom attributes
Custom attributes list
get
Custom attribute create
post
Custom attribute update
patch
Custom attribute delete
del
Firmware
List
get
Detail
get
Archive
post
Update
Firmware update request
post
Firmware update status
get
Cancel update
post
Get a firmware version of a model
get
Device commands
Create
post
Delete
del
Update
patch
Execute
put
Actions
Create
post
Delete
del
Edit
patch
Perform
post
List
get
Get an action
get
Device groups
Categories
List device group categories
get
Create machine group category
post
Edit device group category
patch
Delete device group category
del
Groups
Create
post
List
get
Delete
del
Show
get
Update
patch
Device-Group association
Delete
del
Create
post
Users
Create user-device group association
post
Remove user-device association
del
Users
User update
patch
User create
post
Users list
get
Users detail
get
Current User
Update
patch
Detail
get
Remove one of your 2FA methods
del
Remove a user from an organization
del
Machine shared
get
Roles
Roles list
get
Roles create
post
Edit Role
patch
Get a role
get
Delete a role
del
Device tokens
List
get
Delete
del
Create
post
Update
patch
Consume
post
Generation policies
Create
post
Update
patch
Delete
del
List
get
Plans
Plans
Plans detail
get
Plans create
post
Plans Update
patch
Plan delete
del
Plans list
get
Set default plan
post
Set fallback plan
post
Emails
Emails list
get
Email upsert
put
Audience detail
get
Audience upsert
put
Machine plans
Batch upsert machines plan
put
Upsert machine plan
put
Change the plan of many devices
post
Get a bulk plan change
get
Request plan change
post
Event notifications
List event notifications
get
Event notifications update
put
Push notifications
Register push device
put
Check push device
get
List push devices
get
Update push device
patch
Unregister push device
del
HACCP
HACCP device
get
HACCP email notification detail
get
HACCP email notification update
patch
Download HACCP report as CSV
get
Download HACCP report as Excel
get
Device logs
Download device logs as CSV
get
List logs
get
Notes
Notes list
get
Notes create
post
Notes delete
del
Overview
Alarms
get
Events
get
Daily alarm counts
get
Knowledge base
Get Upload images link
get
Create new document
post
Recipes
Init recipes
get
List recipes
get
Recipe detail
get
Delete recipe
del
Update recipe
patch
Create recipe
post
Cancel write recipes request
get
Read recipes
get
Read recipe
get
Write recipe
post
Delete recipe
del
Recipe templates
Recipe template list
get
Recipe template delete
del
Recipe template create
post
Recipe template update
patch
Recipe template detail
get
Recipe template add to cookbook
post
Cookbooks
Cookbook list
get
Cookbook update
patch
Cookbook create
post
Cookbook detail
get
Cookbook delete
del
Remove a recipe template from a cookbook
del
Cookbook tags
get
Cookbook syncs
Cookbook syncs list
get
Cookbook sync detail
get
Cookbook sync request
post
Cookbook sync log retry
get
Cookbook sync log cancel
post
MQTT API
Introduction
Data ingestion
Realtime monitoring
Parameters
Perform action
Firmware update
Firmware version and list
Recipes
Cookbook sync
Logs
Token exchange
Device tokens
Model change
VPN
Powered by
HTTP API
Copy Page
Knowledge base
Allow knowledge base documents upload.
Updated 9 days ago
Updated 9 days ago