OAuth 2.0 Authentication

Connecteam supports OAuth 2.0 Client Credentials flow for secure, server-to-server API access. Your application authenticates using credentials, receives a short-lived token, and uses that token to call APIs.

When to Use OAuth 2.0

Use OAuth 2.0 if you need:

• Scoped access to specific Connecteam features
• Short-lived tokens (better security than static API keys)
• Server-to-server integrations without user interaction

Step 1: Create an OAuth App

Navigate to: Your Name → Integration Center → OAuth 2.0

1. Click Create app
2. Enter a Display Name (e.g., "Internal Dashboards")
3. Select Scopes (permissions) for your app

🚧

Important

Scopes cannot be edited after app creation. Request only the minimum scopes required.

4. Click Save app

Step 2: Save Your Credentials

After saving, Connecteam generates:

• Client ID
• Client Secret

⚠️

Warning

The Client Secret is shown only once. Copy and store it securely before continuing.

Step 3: Get an Access Token

Exchange your credentials for an access token.

Endpoint: POST https://api.connecteam.com/oauth/v1/token

Authentication: HTTP Basic (Client ID as username, Client Secret as password)

curl --request POST \
  --url https://api.connecteam.com/oauth/v1/token \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --user CLIENT_ID:CLIENT_SECRET \
  --data 'grant_type=client_credentials'

Response

{
  "access_token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...",
  "token_type": "Bearer",
  "expires_in": 86400,
  "scope": "users.read users.write"
}

Access tokens are valid for 24 hours. Implement automatic token renewal before expiration.

Step 4: Use the Access Token

Include the token in the Authorization header:

curl --request GET \
  --url https://api.connecteam.com/users/v1/users \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Never send the Client Secret when calling API endpoints – only use the access token.

Available Scopes

Scopes follow the format feature.permission (e.g., users.read, schedule.write).

Scope Examples

API Reference