Skip to main content

Getting Started

The TeamUp API is a REST API for interacting with your TeamUp business. It accepts and returns JSON, uses standard HTTP response codes, and can power custom websites, mobile apps, and back office automations.

This guide covers the essentials: the base URL, how authentication works, and how to make your first request.

Base URL​

All API endpoints are relative to:

https://goteamup.com/api/v2

For example, the List Events endpoint documented as GET /events is called as https://goteamup.com/api/v2/events.

Create an Application​

The first step is to create an API Application, which represents the system you're integrating with TeamUp. You can create one directly in the business dashboard — see the help guide for the steps.

Authentication​

The API supports three authentication methods, covered in detail on the Authentication page:

  • OAuth (recommended) — your app acts on behalf of an end user (a customer or staff member) using an access token obtained through the OAuth flow. Sent as Authorization: Bearer <TOKEN>.
  • M2M tokens — your app acts on behalf of the business itself, with no user login involved. Ideal for server-to-server and background integrations. Sent as Authorization: Bearer <TOKEN>.
  • Direct Authentication — a fully branded login experience where your app handles user passwords directly. Only enabled after TeamUp reviews your use case.

Your First Request​

The quickest way to make an authenticated request is with an M2M token, which you can create from your business dashboard (see Creating a Machine-to-Machine (M2M) Token).

List the next few events at your business:

curl "https://goteamup.com/api/v2/events?page_size=5" \
  -H "Authorization: Bearer <YOUR_M2M_TOKEN>"

A successful response returns a JSON object containing a list of event objects.

Two request headers are worth knowing about as you go further:

  • TeamUp-Request-Mode — only required when using OAuth tokens where the underlying identity is linked to both a customer and a staff member; clarifies whether the request acts as a provider (staff) or customer. M2M tokens always act in provider mode.
  • TeamUp-Provider-ID — specifies which business the request acts on when your credentials can access more than one.

Both are explained on the Authentication page.

Next Steps​

Getting Help​

Check the FAQ for answers to common questions. For anything else, visit the TeamUp help center.