API Usage

Core patterns for working with the Upbooks API.

API Usage

Access Scopes

Access Scopes

Upbooks™ offers granular access control through scopes, allowing you to define permissions based on specific functionalities. When you create an API key, assign only the scopes your integration needs — this follows least-privilege best practice and limits exposure if a key is ever compromised.

Pre-Sales

Access scope for pre-sales activities, including managing leads, opportunities, and initial customer interactions. Use this scope for CRM syncs, lead capture forms, and marketing automation that creates or updates prospects before they become paying customers.

Sales

Access scope for handling sales-related activities, including creating and managing sales orders, invoicing, and tracking sales performance. Integrations that generate quotes, confirm orders, or push invoice status to a data warehouse typically require Sales scope.

Purchase

Access scope for managing purchase-related activities, such as creating purchase orders, managing suppliers, and tracking inventory. Procurement bots and supplier portals use Purchase scope to raise POs and receive goods without access to payroll or unrelated finance settings.

Operations

Access scope for operational activities, such as managing products, services, and day-to-day business operations. Warehouse systems, catalog sync tools, and internal ops dashboards commonly rely on Operations scope.

Finance

Access scope for financial management tasks, including managing accounts, processing payments, and generating financial reports. Accounting exports, payment reconciliation jobs, and executive reporting pipelines should be granted Finance scope explicitly.

Best practices

Review scopes during key rotation. Separate keys per integration so you can revoke one connector without disrupting others. Combine scopes only when a single service truly needs cross-module access.

Developer Tools

We provides essential resources like Postman collections and comprehensive API documentation to aid developers in testing, integration, and troubleshooting.