Skip to main content

Getting started

This guide walks through making your first request to the Ceros API.

1. Get an API key​

External integrations authenticate with an API key. Generate one from your Ceros account settings.

note

Treat the key as a secret. Don't commit it or expose it in client-side code.

2. Base URL​

All requests go to:

https://rest.ceros.com

3. Authenticate​

Send your API key as a Bearer token in the Authorization header:

Authorization: Bearer YOUR_API_KEY

4. Make a request​

Combine the base URL, your key, and an endpoint from the API Reference (see the top navigation for exact paths and parameters):

curl https://rest.ceros.com/{endpoint} \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "x-ceros-api-version: 2026-05-28-09-00"

Responses are JSON.

5. Pin an API version​

The x-ceros-api-version header selects which version of the API contract your request is served against. If you omit it, the request uses the latest version, which can change as the API evolves. For stable integrations, pin an explicit version.

See API versioning for how versions are named, how to choose one, and how to browse historical versions in the reference.

Next steps​

  • Browse the API Reference (top navigation) for the full list of endpoints.
  • Read API versioning before you ship.