---
updatedAt: 2026-06-26T12:43:07.000Z
---

Fetch the complete documentation index at: https://developer.connecteam.com/llms.txt. Use this file to discover all available pages before exploring further.

# Introduction

## Connecteam API Documentation

Welcome to the Connecteam API Documentation. This hub provides everything you need to integrate, automate, and extend Connecteam's workforce management platform.

***

## Documentation Resources

| Resource                                                     | Description                                                                                           |
| :----------------------------------------------------------- | :---------------------------------------------------------------------------------------------------- |
| [API Reference](https://developer.connecteam.com/reference/) | Complete endpoint documentation with request/response schemas. **Always the most up-to-date source.** |
| Guides (this section)                                        | Tutorials, best practices, and detailed explanations                                                  |
| [Changelog](https://developer.connecteam.com/changelog)      | Latest updates and new features                                                                       |
| [Discussion Board](https://developer.connecteam.com/discuss) | Community Q\&A and support                                                                            |

> 🚧 Important
>
> The **[API Reference](https://developer.connecteam.com/reference/)** is the authoritative source for endpoint specifications and is updated in real-time with production. These guides provide helpful context and examples, but may occasionally differ from the latest API behavior. When in doubt, refer to the API Reference.

***

## Quick Start

1. **Get your API key**: Settings → API Keys → Add API Key
2. **Authenticate**: Include `X-API-KEY: <your_key>` in request headers
3. **Make your first call**: `GET https://api.connecteam.com/me`

***

## Base URLs

| Region    | Base URL                        |
| :-------- | :------------------------------ |
| Global    | `https://api.connecteam.com`    |
| Australia | `https://api-au.connecteam.com` |

***

## Key Concepts

* **Flexible Schemas**: Our API evolves continuously. New fields may be added to responses – implement flexible schema validation to maintain compatibility.
* **Rate Limits**: Requests are limited per plan. See [Rate Limiting](rate-limiting-1) for details.
* **Pagination**: List endpoints use `limit` and `offset` parameters. See [Pagination](pagination-1).
* **Beta Endpoints**: Some endpoints are released in Beta before general availability. See [Beta Endpoints](beta-endpoints) for stability expectations and contact information.

***

## SDK Notice

> 📝 Note
>
> The SDK suggested in the API reference sandbox is a third-party package, not an official Connecteam SDK.