Skip to main content

TeamUp API – FAQ

Table of Contents​

What is the API base URL?​

All API endpoints are relative to:

https://goteamup.com/api/v2

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

There is no api.goteamup.com subdomain — URLs like https://api.goteamup.com/... have never existed. If a tutorial or AI assistant suggests them, use https://goteamup.com/api/v2/... instead.

How do I find my provider ID?​

Your provider ID (sometimes called your business ID) is the number at the start of your Customer Site URL. For example, if your customer site is at https://goteamup.com/p/12345-your-business-name, your provider ID is 12345.

You can also discover it programmatically: call the Authenticated Application endpoint (GET /auth/application) and the response's scoped_providers field lists the provider IDs your credentials can access.

The provider ID is the value to use in the TeamUp-Provider-ID request header — see Authentication.

Is there a sandbox or test environment?​

There is no separate sandbox environment. To test your integration, sign up for a free trial account at goteamup.com and use it as a test business — trial accounts can create API Applications and use the API like any other account.

Does API access cost anything?​

No. There is no extra fee for API access, and the v2 API is the same API that TeamUp's own web and mobile apps use — external developers get the same functionality. You don't need a paid plan to start building: free trial accounts can create API Applications too.

Who can create an API Application?​

API Applications are created and managed by staff members with the super admin permission at the business (typically the business owner). Applications are created directly in the business dashboard — see How do I get API access? below. No paid subscription is required; free trial accounts can create Applications.

What happened to the Business and Customer APIs?​

We’ve moved from two parallel APIs (Customer vs Business) to a single unified API, where the permissions and behavior are determined by who you are authenticated as (business staff vs customer), rather than which URL you call.

One model, different capabilities​

Previously, you had to decide "am I using the Customer API or the Business API? even though they operated on the same underlying objects (classes, attendances, memberships, etc.).

With v2:

There is one set of endpoints and one data model.

The identity behind the credentials (staff vs customer) determines:

  • Which fields you can see.
  • Which actions you can perform.
  • Which business rules are enforced (e.g., registration windows for customers, but not staff).

So instead of "pick the right API," the rule becomes "authenticate as the right user" which matches how permissions work in our main web app and mobile app products.

How do I get API access?​

You can create an API Application directly in our product. For details see: https://support.goteamup.com/en/articles/9327305-the-teamup-api.