Skip to content
Last updated

Introduction to the Caraer API

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.

Base URL and versioning

All endpoints are under the /api/v2 path. Your requests should target your Caraer environment's base URL (for example, your company's API host) plus this path.

Example base URL for requests:

https://v2.api.caraer.com/api/v2

(Replace with the base URL provided for your Caraer environment.)

Authentication

The API uses Bearer token authentication. Include a valid access token in the Authorization header of every request:

Authorization: Bearer <your-access-token>

Obtain an access token through your Caraer account or your organization's admin. Without a valid token, requests will return 401 Unauthorized.

Important:
In addition to the Authorization header, you must also include the X-Caraer-Company-Uuid header in most requests. This header identifies your Caraer environment and ensures access to the correct company context.

Example headers:

Authorization: Bearer <your-access-token>
X-Caraer-Company-Uuid: <your-company-uuid>

You can obtain your Company UUID from your Caraer admin or via the platform settings. Omitting this header will generally result in an error or access to the wrong environment.

Using this reference

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.

Next steps

  • Open API Reference in the sidebar and pick a tag (e.g. Objects, Records, Forms) to see the endpoints for that area.
  • Ensure every request includes the Authorization: Bearer <token> header.
  • Use the base URL for your environment and the /api/v2 prefix for all paths in this reference.
 
Next page