Australian clients

Australian-hosted companies use a different API base URL. Paths, headers, authentication, and request bodies are the same as the global API. Only the host changes.

🚧

Important

If your company is hosted in Australia, send all API requests to https://api-au.connecteam.com. Do not use https://api.connecteam.com.


How to know you are an Australian client

Check where you sign in to Connecteam:

Dashboard URLAPI base URL
https://app.connecteam.comhttps://api.connecteam.com
https://app-au.connecteam.comhttps://api-au.connecteam.com

If you log in at app-au.connecteam.com, you are an Australian client and must use the Australian base URL.


Base URL

https://api-au.connecteam.com

Replace https://api.connecteam.com with this host in every example in these docs and in the API Reference.


Authentication

Authentication is the same as the global API:

  • API key — X-API-KEY header. Create the key in your Australian dashboard: Settings → API Keys.
  • OAuth 2.0 — request the token from the Australian host, then call APIs on the same host. See OAuth 2.0.

Examples

Get account details

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

Get users

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

Get an OAuth access token

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

Then call any endpoint with the same Australian host:

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

What's the same

  • Endpoint paths (for example /me, /users/v1/users, /time-clock/v1/time-clocks)
  • API key and OAuth scopes
  • Request and response bodies
  • Rate limiting and pagination

The only change is the base URL.


Authentication Ā· OAuth 2.0 Ā· API Reference


Did this page help you?