Misc
Logout
Revokes the current Bearer token.
List Users
Returns a paginated list of users for the current tenant, with Spatie QueryBuilder filtering and sorting. Includes soft-deleted users.
List Integration Instances
Returns all integration instances (connections to external platforms like Shopify, Amazon, Xero, etc.).
List Table Views
Returns saved table views (column layouts and filter presets) for a given datatable.
Create Table View
Creates a new saved table view.
Account Setup
Completes initial account setup after registration.
Get Company Profile
Returns the company profile settings.
Update Company Profile
Updates the company profile.
App Settings
Returns global application settings (feature flags, configuration) for the frontend.
List Activity
Returns a paginated activity/audit log across all entities.
Update Address
Updates an address record.
Delete Address
Deletes an address record.
Check If Address Is Deletable
Checks whether an address can be safely deleted (not referenced by active records).
Check If Address Is Locked
Checks whether an address is locked (read-only due to being used in finalized orders).
List Alert Preferences
Returns the current user's alert notification preferences.
Bulk Update Alert Preferences
Updates multiple alert preferences at once.
Create Note
Creates a note on a noteable entity (SalesOrder, PurchaseOrder, etc.).
Update Note
Updates a note.
Delete Note
Deletes a note.
Global Search
Performs a global search across multiple entity types.
Lookup
Generic autocomplete lookup endpoint used by select/dropdown inputs throughout the UI. Returns a list of matching records for a given entity type.
List Enums
Returns all application enum values used by the frontend for dropdowns and validation.
List Constants
Returns application constants used for frontend configuration.
List Sales Channels
Returns all sales channels (Shopify stores, Amazon marketplaces, etc.).
List User API Keys
Returns all API keys for the current user.
Create API Key
Creates a new API key for the current user. The token is only shown once in the response.
Delete API Key
Revokes an API key.
Update Table View
Updates a saved table view.
Delete Table View
Deletes a saved table view.
Change Password
Changes the current user's password.
Get Low Stock Items
Returns products that are at or below their reorder point.
Export Low Stock Items
Exports low-stock items as a downloadable CSV or XLSX file.
Inventory Management Settings
Returns inventory management configuration settings.
Show Discount Code
Returns a single discount code.
Update Discount Code
Updates a discount code.
Delete Discount Code
Deletes a discount code.
Update Custom Field
Updates a custom field definition.
Delete Custom Field
Deletes a custom field definition.
Update Custom Field Values
Sets custom field values for a specific entity instance.
List Sales Reps
Returns all sales representatives.
List Webhooks
Returns all configured outbound webhooks.
Create Webhook
Creates a new outbound webhook.
Show Webhook
Returns a single webhook.
Update Webhook
Updates a webhook.
Delete Webhook
Deletes a webhook.