Skip to content
Authors
  • Sem Tadema
    Sem TademaCTO

This tutorial walks you through making your first request to the Caraer API.

Prerequisites

  • A Caraer account and access to your environment's API base URL
  • A valid Bearer token (from your Caraer admin or account settings)

Step 1: Get your base URL and token

Your API base URL is the host for your Caraer environment (for example https://your-company.caraer.com). All API requests use the path prefix /api/v2.

Obtain a Bearer token from your Caraer admin or the developer section of your account. You will send this in the Authorization header.

Step 2: Call an endpoint

Example: fetch the current user with the Developer endpoint (if available in your environment):

curl -X GET "https://your-company.caraer.com/api/v2/developer/me" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json"

Replace YOUR_ACCESS_TOKEN with your token and adjust the base URL to your environment.

Step 3: Use the response

The API returns JSON. Use the API reference to explore other endpoints (objects, records, forms, webpages, and more) and build your integration.

Next steps