The Caraer API lets you integrate with the Caraer platform programmatically. Use it to manage objects, records, forms, webpages, relations, and more from your own applications, scripts, or services.
All endpoints are under the https://v2.api.caraer.com/api/v2 path.
For integrations that use an application token (API key–style), send the raw token in this header (do not prefix with Bearer):
X-CARAER-TOKEN: <your-api-token>This path authenticates an application principal and automatically recognises the company based on the token. Obtain API tokens from your Caraer admin or integration setup as applicable.
The sidebar is organized by tag (e.g. Objects, Records, Forms, Webpages). Each section lists the endpoints for that area of the API.
For each endpoint you'll find:
- HTTP method and path — The verb and URL path to call.
- Parameters — Path, query, and header parameters, including required/optional and types.
- Request body — Schema and description when a body is required.
- Responses — Status codes and response schemas.
Use the API Reference section in the sidebar to browse endpoints and try the "Try it out" flow in the docs where available.
- Open API Reference in the sidebar and pick a tag (e.g. Objects, Records, Forms) to see the endpoints for that area.
- Ensure every protected request includes
X-CARAER-TOKEN: <token>.