Skip to main content

​
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 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 page for detailed instructions on how to obtain your API keys.

​
2. Make Your First Request

Here’s a simple example to get started: 
```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"

​
3. Handle the Response

The API returns data in this format: 
{
	"data": [
		{
			"firstName": "John",
			"lastName": "Doe",
			"email": "[email protected]",
			"startDate": "01/15/2025",
			"endDate": "01/22/2025",
			"status": "Confirmed",
			"role": "Patient",
			"ids": {
				"role": "patient",
				"status": "confirmed",
				"sessionId": "sess_123456"
			}
		}
	],
	"total": 1
}