Settings
Connect the API
Enable the team API from Settings, create a read-only key, and call /api/v1 for cars and customers.
The public API is already built. Settings → Integrations is where you turn it on, create a key, and open the docs. After it is on, the same keys also stay on Settings > Team.
This lives under Settings > Integrations.
What you will accomplish
- Enable API from Settings → Integrations.
- Create a team-scoped key with
read:carsand/orread:customers. - Copy the secret once and store it in your integration.
- Confirm a request in the interactive docs at
/api-docs.
Before you start
- You need admin access to turn the API on and to create or revoke keys.
- You need the Schedule permission to open Settings > Integrations.
- Know which system will call CSS so you can name the key after that vendor.
Enable the API and create a key
- Open Integrations
Go to Settings > Integrations and click API.
- Turn it on
Enable the integration. The same dialog then shows key management and a link to the docs.
- Create an API key
Click Create API key, name it, choose scopes, and optionally set an expiration. Copy the secret immediately — it is shown only once.
- Call /api/v1
Send the key as
Authorization: Bearer <api_key>orx-api-key: <api_key>.GET /api/v1/carsneedsread:cars.GET /api/v1/customersneedsread:customers.
The card shows On after you enable it, and Connected after at least one active key exists.
What success looks like
- The API card shows Connected.
GET /api/v1/carsorGET /api/v1/customersreturns only this team's records.- Interactive docs at
/api-docsload and accept the same key.