Skip to main content

API Documentation

Unlock the power of workforce management with Connecteam API

Adva Deuitch avatar
Written by Adva Deuitch
Updated over 2 weeks ago

Connecteam’s API allows you to integrate Connecteam with your internal systems and external tools. It helps automate workflows, sync data, and customize how you use the platform. This enables more efficient operations and a better experience for your team.



How to Set Up an API Key

1. Click your Admin icon in the top-right corner of the screen.

2. Select Integrations from the menu

3. Click the API Key tab.

4. Click Add API Key.

5. Enter a Key name (required).

6. Select an Expiry date and time (optional).

7. Click Confirm to generate the key.

8. Copy the generated API key.

9. Paste the API key into your company’s internal system to complete the connection.


Managing API Keys

You can manage existing API keys directly from the API Key tab.

To edit, disable, or delete an API key, follow these steps:

  1. Navigate to Integrations.

  2. Open the API Key tab.

  3. Click the three-dot menu next to the relevant API key.

  4. Select Edit, Disable, or Delete, depending on your needs.

Disabling a key immediately stops all integrations using that key.


API Availability

The Connecteam API is available on the Expert plan across any hub.

  • If your account is not on the Expert plan, the API Key tab will not appear.

  • API settings are accessible to owners only.


Frequently Asked Questions

Q: Who can access the API Key settings?
A: Only account owners can access and manage API keys.

Q: What plan is required to use the Connecteam API?
A: The API is available only on the Expert plan.

Q: Can I create multiple API keys?
A: Yes, you can create multiple API keys and manage them individually.

Q: What happens if I delete an API key?
A: Any integration using that key will stop working immediately.

Q: Is an expiry date required when creating an API key?
A: No, the expiry date is optional. If set, the key will stop working once it expires.


Need more guidance? 🙋 Our LIVE support team (at the bottom right corner of your screen) replies to ANY question.

Did this answer your question?