Overview / System

System

Devices, panel users, roles, webhooks, brand settings, billing and the audit log.

Where this is in the panel

System → Device fleet
System → Users
System → Roles
System → Webhooks
System → API keys
System → Settings
System → Subscription & billing
System → Audit log

Endpoints

get /v1/printers

List receipt printers

devices.read

post /v1/printers

Register a printer

devices.write

get /v1/printers/{printer}

Get one printer

devices.read

patch /v1/printers/{printer}

Update a printer

devices.write

delete /v1/printers/{printer}

Delete a printer

devices.write

post /v1/printers/{printer}/test

Print a test receipt

devices.write

get /v1/devices

List devices

devices.read

post /v1/devices

Register a device

devices.write

get /v1/devices/{device}

Get one device

devices.read

patch /v1/devices/{device}

Update a device

devices.write

delete /v1/devices/{device}

Remove a device

devices.write

post /v1/devices/{device}/heartbeat

Device check-in

devices.write

post /v1/devices/{device}/lock

Lock a device

devices.write

post /v1/devices/{device}/unlock

Unlock a device

devices.write

get /v1/users

List panel users

users.read

post /v1/users

Invite a user

users.write

get /v1/users/{user}

Get one membership

users.read

patch /v1/users/{user}

Change role or scope

users.write

delete /v1/users/{user}

Remove a membership

users.write

post /v1/users/{user}/resend-invitation

Resend an invitation

users.write

post /v1/users/{user}/deactivate

Suspend access

users.write

post /v1/users/{user}/activate

Restore access

users.write

post /v1/users/{user}/revoke-invitation

Revoke a pending invitation

users.write

post /v1/users/{user}/reset-two-factor

Reset two-factor authentication

users.write

post /v1/users/{user}/send-password-reset

E-mail a password reset link

users.write

get /v1/roles

List roles

roles.read

post /v1/roles

Create a role

roles.write

get /v1/roles/{role}

Get one role

roles.read

patch /v1/roles/{role}

Update a role

roles.write

delete /v1/roles/{role}

Delete a role

roles.write

get /v1/permissions

Permission catalog

roles.read

get /v1/webhooks

List webhooks

webhooks.read

post /v1/webhooks

Create a webhook

webhooks.write

get /v1/webhooks/{webhook}

Get one webhook

webhooks.read

patch /v1/webhooks/{webhook}

Update a webhook

webhooks.write

delete /v1/webhooks/{webhook}

Delete a webhook

webhooks.write

get /v1/webhooks/{webhook}/deliveries

Delivery attempts

webhooks.read

post /v1/webhooks/{webhook}/rotate-secret

Rotate the signing secret

webhooks.write

post /v1/webhooks/{webhook}/test

Send a test delivery

webhooks.write

post /v1/webhooks/{webhook}/reactivate

Reactivate a stopped endpoint

webhooks.write

post /v1/webhooks/{webhook}/reveal-secret

Show the signing secret

webhooks.write

get /v1/webhook-events

Subscribable events

webhooks.read

get /v1/settings

Brand settings

settings.read

patch /v1/settings

Update brand settings

settings.write

get /v1/integrations

List integrations

settings.read

post /v1/integrations/{provider}/toggle

Connect or disconnect an integration

settings.write

get /v1/billing

Current subscription

billing.read

get /v1/billing/plans

Available plans

billing.read

get /v1/billing/invoices

Subscription invoices

billing.read

get /v1/billing/invoices/{invoice}/download

Download an invoice as PDF

billing.read

post /v1/billing/subscribe

Change plan

billing.write

get /v1/activity

Audit log

activity.read