> ## Documentation Index
> Fetch the complete documentation index at: https://help.teamm.work/llms.txt
> Use this file to discover all available pages before exploring further.

# Getting Started

> Quick start guide for integrating with the Teamm API

## Base URL

All API requests should be made to:

```
https://api.teamm.work
```

## Prerequisites

Before you begin, ensure you have:

* A TeamM center account with API access enabled
* API keys from your center's settings
* Basic understanding of REST APIs

## Authentication

All API endpoints require authentication. Please see the [Authentication](/api-reference/authentication) page for detailed information about required headers and how to obtain your API keys.

## Data Format

The TeamM API returns data in **humanized format**, meaning all information is localized and ready for display in your application. Use the `X-LOCALE` header to specify your preferred language.

## Rate Limits

The API has the following rate limits:

* **1000 requests per hour** per API key
* **Burst limit**: 100 requests per minute

## Quick Start

### 1. Obtain API Keys

Please see the [Authentication](/api-reference/authentication) page for detailed instructions on how to obtain your API keys.

### 2. Make Your First Request

Here's a simple example to get started:

<CodeGroup>
  ````bash cURL theme={null}
  ```bash cURL
  curl -X GET "https://api.teamm.work/v1/guests" \
    -H "X-API-APP-ID: your-app-id" \
    -H "X-API-PUBLIC-KEY: your-public-key" \
    -H "X-API-SECRET-KEY: your-secret-key" \
    -H "X-LOCALE: en" \
    -G -d "startDate=2025-01-01" \
       -d "endDate=2025-01-31" \
       -d "start=1" \
       -d "length=10"
  ````

  ```javascript JavaScript theme={null}
  const response = await fetch(
  	'https://api.teamm.work/v1/guests?' +
  		new URLSearchParams({
  			startDate: '2025-01-01',
  			endDate: '2025-01-31',
  			start: '1',
  			length: '10',
  		}),
  	{
  		headers: {
  			'X-API-APP-ID': 'your-app-id',
  			'X-API-PUBLIC-KEY': 'your-public-key',
  			'X-API-SECRET-KEY': 'your-secret-key',
  			'X-LOCALE': 'en',
  		},
  	}
  );

  const data = await response.json();
  console.log(data);
  ```

  ```python Python theme={null}
  import requests

  url = "https://api.teamm.work/v1/guests"
  headers = {
      "X-API-APP-ID": "your-app-id",
      "X-API-PUBLIC-KEY": "your-public-key",
      "X-API-SECRET-KEY": "your-secret-key",
      "X-LOCALE": "en"
  }
  params = {
      "startDate": "2025-01-01",
      "endDate": "2025-01-31",
      "start": 1,
      "length": 10
  }

  response = requests.get(url, headers=headers, params=params)
  data = response.json()
  print(data)
  ```

  ````

  ```javascript JavaScript
  const response = await fetch(
  	'https://api.teamm.work/v1/guests?' +
  		new URLSearchParams({
  			startDate: '2025-01-01',
  			endDate: '2025-01-31',
  			start: '1',
  			length: '10',
  		}),
  	{
  		headers: {
  			'X-API-APP-ID': 'your-app-id',
  			'X-API-PUBLIC-KEY': 'your-public-key',
  			'X-API-SECRET-KEY': 'your-secret-key',
  			'X-LOCALE': 'en',
  		},
  	}
  );

  const data = await response.json();
  console.log(data);
  ````
</CodeGroup>

### 3. Handle the Response

The API returns data in this format:

```json theme={null}
{
	"data": [
		{
			"firstName": "John",
			"lastName": "Doe",
			"email": "john.doe@example.com",
			"startDate": "01/15/2025",
			"endDate": "01/22/2025",
			"status": "Confirmed",
			"role": "Patient",
			"ids": {
				"role": "patient",
				"status": "confirmed",
				"sessionId": "sess_123456"
			}
		}
	],
	"total": 1
}
```