Shigoto DocumentationDocs Release Notes Partner Integration API

Introduction
/admin/apikey: Delete an API key.
/admin/user: Delete a user from an account.
deleteAuthApikey
/admin/accountOptions: Get the AccountOptions for an account.
/admin/account: Get full details for a specific account.
/admin/accounts: Retrieve all accounts visible within the caller’s scope.
/admin/apikey: List API keys for the specified scope.
/admin/billing: Retrieve billing information for a quarter.
/admin/billingtext: Retrieve billing information for a quarter as ascii text.
/admin/getDevicesForLocations: Get all devices grouped by location.
/admin/getLocations: Get all locations of an account.
/admin/paymentplan: Retrieve payment plans for an account.
/admin/tenantOptions: Get the TenantOptions for a tenant.
/admin/tenants: Get tenants visible within the caller’s scope.
/admin/unpairDevice: Unpair a single device by its serial ID.
/admin/unpairLocation: Unpair all devices assigned to a location.
/admin/version: Version returns current version as string (1.2.3.2345)
getAuthApikey
/auth/check: Macht einen Check ob User bereits authorisiert ist
getAuthConfig
/statistic/entries: Get raw occupancy records for an account or a single location.
/admin/version: Version returns current version as string (1.2.3.2345)
/admin/invalidate/account: Invalidate all active sessions for an account.
/admin/invalidate/client: Request a client device to reset itself.
/admin/accountOptions: Set the AccountOptions for an account.
/admin/account: Update mutable properties of an account.
/admin/apikey: Create or update an API key.
/admin/device: Create or update a device.
/admin/pair: Pair Location
/admin/paymentplan: Create or update a payment plan for an account.
/admin/statistic/cleanup: Run the occupancy statistics cleanup now.
/admin/tenantOptions: Set the TenantOptions for the caller's tenant.
/admin/user: Update a user's profile.
postAuthApikey
/auth/AuthorizeSensor: Authorize a client device on behalf of a logged-in tenant user/API-Key.
postAuthChangepassword
postAuthForgot
postAuthInvite
postAuthLoginToken
postAuthLogin
postAuthLogoff
postAuthRegister

postAuthForgot

postAuthForgot

POST /auth/forgot

postAuthForgot

Request

Responses

200

OK

postAuthForgot

/auth/forgot

Request​

Responses​

Request

Responses