Unique IDs

Upbooks™ API – Unique IDs and Entity Retrieval

MongoDB ObjectId Overview

Upbooks™ uses MongoDB’s unique ObjectId to identify entities within the system. ObjectId is a 12-byte identifier composed of a timestamp, machine identifier, process identifier, and counter.

Fetching Details of a Single Client

Use the following endpoint:

GET https://api.upbooks.io/api/v1/client/{id}

Replace {id} with the ObjectId of the client you wish to retrieve.

Sample cURL Request

curl -X GET https://api.upbooks.io/api/v1/client/5f4e792263a64c0021e536fb \
  -H "Authorization: Bearer YOUR_JWT_TOKEN" \
  -H "Organization-ID: YOUR_ORGANIZATION_ID" \
  -H "API-KEY: YOUR_API_KEY"

Notes on ObjectId

Ensure that the ObjectId provided is valid and corresponds to an existing entity in the Upbooks™ system.

API Usage