Introduction
Here you will find all the documentation related to each product we are or have worked on.
The documents in this site are not meant to outline how to use the API endpoints, rather how to build and maintain it. We outline what it's capabilities should be, once you have built them, you can create documentation for our clients on how to utilize them on the BackBone site.
- Products
- API
Products
intro
Headersβ
"Content-Type":"application/json"
use this for all endpoints
Parameters
{
"token": "your_token_here"
}
if you don't have one use calm commerce dashboard to create one
sidebar_position: 1β
Intro
Welcome to the BackBone CMS API documentation. This guide outlines the base requirements and common patterns used throughout the API.
Headersβ
All requests must include the following header:
{
"Content-Type": "application/json"
}
Parametersβ
Authentication is done via a token provided in the request payload or headers, depending on the endpoint.
{
"token": "your_token_here"
}
API Structureβ
While this document doesnβt go into full details for every endpoint, hereβs what you should know about the conventions used:
General Structureβ
-
All endpoints are RESTful.
-
Routes are grouped by resource (
/assets,/projects,/users, etc.). -
Standard HTTP verbs are used:
GETfor fetching dataPOSTfor creating new entriesPUT/PATCHfor updatesDELETEfor deletions
Asset Base Routesβ
| Method | Route | Description | Doc |
| -------- | ---------------------- | --------------------------- | Doc |
| GET | /assets | Get all assets | Doc |
| GET | /assets/:id | Get asset by ID | Doc |
| POST | /assets | Create a new asset | Doc |
| PUT | /assets/:id | Update an existing asset | Doc |
| DELETE | /assets/:id | Delete an asset | Doc |
| GET | /projects/:id/assets | Get all assets in a project | Doc |
Most update/create endpoints expect full or partial JSON objects matching the schema from the Data Model docs.
Testing the APIβ
You can test the API using Postman or any other HTTP client. Be sure to:
- Set
Content-Type: application/jsonin headers. - Include your token in the request body or headers.
- Use the proper route and payload format.
Notesβ
- API is subject to rate limits β if your requests are throttled, try again after a short delay.
- For real-time updates or webhooks, check the Integrations section (coming soon).
- All
DateTimefields are in ISO 8601 format (e.g.,"2025-07-04T12:00:00Z").
For specific endpoints, go to the Assets or Projects documentation pages.