API Usage

Core patterns for working with the Upbooks API.

API Usage

Pagination

Upbooks™ API – Pagination

Upbooks™ APIs support pagination for list responses using pageNo and pageSize headers.

Pagination Headers

Authorization: Bearer YOUR_JWT_TOKEN
Organization-ID: YOUR_ORGANIZATION_ID
API-KEY: YOUR_API_KEY
pageNo: 1
pageSize: 10

Example: Client List API

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

Headers:

Authorization: Bearer YOUR_JWT_TOKEN
Organization-ID: YOUR_ORGANIZATION_ID
API-KEY: YOUR_API_KEY
pageNo: 1
pageSize: 20

Pagination Response

{
  "data": [
    {"clientId": "123", "name": "Client 1"},
    {"clientId": "456", "name": "Client 2"}
  ],
  "totalCount": 50,
  "filteredCount": 20,
  "message": "Clients retrieved successfully"
}

Adjusting Pagination

Modify pageNo and pageSize to navigate through pages and control items per page.

Developer Tools

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