Quickstart

Three steps to your first call.

1. Create a key

In claritos: Organization → Settings → API → Create key. Pick only the scopes your integration needs. The key (capi_…) is shown exactly once — copy it right away.

2. First call: GET /me

Send the key as a bearer token. GET /me returns organization, scopes and limits of your access — proof that everything is wired up.

curl

curl https://www.claritos.io/api/v1/me \
  -H "Authorization: Bearer capi_…"

typescript

const res = await fetch("https://www.claritos.io/api/v1/me", {
  headers: { Authorization: "Bearer capi_…" },
});
const me = await res.json();

python

import requests

r = requests.get("https://www.claritos.io/api/v1/me",
    headers={"Authorization": "Bearer capi_…"})
print(r.json())

php

$ch = curl_init("https://www.claritos.io/api/v1/me");
curl_setopt($ch, CURLOPT_HTTPHEADER, ["Authorization: Bearer capi_…"]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$me = json_decode(curl_exec($ch), true);

req, _ := http.NewRequest("GET", "https://www.claritos.io/api/v1/me", nil)
req.Header.Set("Authorization", "Bearer capi_…")
res, err := http.DefaultClient.Do(req)

SDK instead of raw HTTP

The same calls with the official SDKs — TypeScript (@claritos/api) and Python (claritos). Details in the “SDKs” guide.

typescript (sdk)

import { createClaritos, metaMe } from "@claritos/api";

const claritos = createClaritos({ apiKey: process.env.CLARITOS_API_KEY! });
const { data: me } = await metaMe({ client: claritos });

python (sdk)

from claritos import create_client
from claritos_api.api.organization import meta_me

client = create_client(api_key="capi_…")
me = meta_me.sync(client=client)

3. Next

Browse the reference, read errors and pagination, then connect your first domain. For Zapier, n8n and Make: subscribe to webhooks once available.