Authentication

All API requests must be authenticated using your secret API key.

Obtaining Your API Key

  1. Log in to your Connecteam account
  2. Go to Settings → API Keys
  3. Click Add API key
🚧

Important

Your API key is equivalent to a password. Never share it publicly or store it in client-side code.

Making Authenticated Requests

Include your API key in the X-API-KEY header:

curl --request GET \
  --url 'https://api.connecteam.com/me' \
  --header 'Accept: application/json' \
  --header 'X-API-KEY: YOUR_API_KEY'

Alternative: OAuth 2.0

For enhanced security with scoped access and short-lived tokens, see OAuth 2.0.


API Reference