API Documentation
Tuesday, March 10, 2026
Download OpenAPI
Swagger UI
Account API
GET
/v1/account
Get current account
GET
/v1/account/id
Get current account id
Device API
GET
/v1/devices
Find devices
GET
/v1/devices/{device-id}
Get specific device
PUT
/v1/devices/{device-id}/name
Set a device name
PUT
/v1/devices/{device-id}/details
Set a device location and remarks
GET
/v2/devices
Find devices (v2)
GET
/v2/devices/{device-id}
Get specific device (v2)
Device Group API
Business clients only
GET
/v1/device-groups
Get all device groups
GET
/v1/device-groups/{id}
Get a specific device group
POST
/v1/device-groups
Create a device group
PUT
/v1/device-groups/{id}
Update a device group
DELETE
/v1/device-groups/{id}
Delete a device group
GET
/v1/device-groups/{id}/devices
Get all devices from a group
POST
/v1/device-groups/{id}/devices
Add multiple devices to a device group
DELETE
/v1/device-groups/{id}/devices
Remove multiple devices from a device group
POST
/v1/device-groups/{id}/devices/{deviceId}
Add a device to a device group
DELETE
/v1/device-groups/{id}/devices/{deviceId}
Remove a device from a group
Device Remote API
POST
/v1/devices/{device-id}/remote-activation
Remote activate a device
POST
/v1/devices/{device-id}/remote-deactivation
Remote deactivate a device
OAuth API
Authenticate user with OAuth 2
POST
/v2/oauth/token
OAuth Authentication
POST
/v2/oauth/revoke
OAuth token revocation
POST
/v2/oauth/revoke-all
Revoke OAuth Authentication
Organization API
GET
/v1/organization
Get current organization
GET
/v1/organizations/{id}
Get organization
PUT
/v1/organizations/{id}
Update organization details
Shares API
GET
/v2/shares
Get
GET
/v2/shares/{share-id}
Get Share
GET
/v2/shares?externalId={externalId}
Get Share
POST
/v2/shares
Create a share
PUT
/v2/shares/{share-id}
Update a share
POST
/v2/shares/{share-id}/web-key
Create a web key
GET
/v1/web-keys/{uuid}
Get a web key
PUT
/v2/shares/{share-id}/name
Update a share name
DELETE
/v2/shares/{share-id}
Delete a share
User API
GET
/v2/users
Get users
GET
/v2/users/{user-id}
Get user
PUT
/v2/users/{user-Id}
Update user
PUT
/v2/users/{user-Id}/invitation
Update user invitation
POST
/v2/users
Create user
POST
/v2/users/{user-id}/impersonate
Impersonate user
PUT
/v2/users
Import users
DELETE
/v2/users/{user-id}
Delete user
User Group API
Business clients only
GET
/v1/user-groups
Get users groups
GET
/v1/user-groups/{id}
Get a specific user group
POST
/v1/user-groups
Create a user group
PUT
/v1/user-groups/{id}
Update a user group
DELETE
/v1/user-groups/{id}
Delete
POST
/v1/user-groups/{id}/users/{userId}
Add a user to a group
POST
/v1/user-groups/{id}/users
Add multiple users to a group
PUT
/v1/user-groups/{id}/users
Update users in a group
DELETE
/v1/user-groups/{id}/users
Remove multiple users from a group
DELETE
/v1/user-groups/{id}/users/{userId}
Remove a user from a group
Webhooks API
POST
/v2/webhooks
Create a webhook
GET
/v2/webhooks
Find all webhooks
DELETE
/v2/webhooks/{webhook-id}
Delete a webhook