Orvelt
API reference

Business API reference

Browse every public Business API operation by functionality.

The public Business API uses organization-wide API keys and the base URL https://api.orvelt.com/v1. Each operation page lists its method, path, permission, parameters, response, and errors.

Request examples

Compare SDK and cURL requests

TypeScript SDK examples use the grouped operations exported by @orvelt/business. The cURL tab sends the equivalent HTTP request. Set ORVELT_API_BASE_URL to the API base URL without a trailing slash before running a cURL example.

Permissions

Match the key to the operation

Every operation declares its required API-key permission. Read Permissions before creating a restricted key.