API Usage

Core patterns for working with the Upbooks API.

API Usage

Sorting

Upbooks™ API – Sorting

Sorting list responses is supported using sortBy and sortOrder headers.

Sorting Headers

Authorization: Bearer YOUR_JWT_TOKEN
Organization-ID: YOUR_ORGANIZATION_ID
API-KEY: YOUR_API_KEY
sortOrder: 1 | -1
sortBy: fieldName

Example: Client List API

GET https://api.upbooks.io/api/v1/clients

Use with pagination headers as needed. sortOrder of 1 means ascending and -1 means descending.

Sorting Response

Same response envelope as pagination; items are ordered according to sortBy and sortOrder.

Adjusting Sorting

Change sortBy and sortOrder to control ordering.

Developer Tools

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