canonical: https://jentic.com/apis/goteamup.com/goteamup

# Goteamup TeamUp REST API

Jentic publishes the only available OpenAPI specification for TeamUp REST API, keeping it validated and agent-ready. The TeamUp REST API powers fitness, wellness, and class-based businesses with 461 endpoints covering bookings, attendances, classes, customers, payments, memberships, instructors, locations, communications, and reporting. Authentication uses bearer JWT or token authentication issued from the TeamUp business dashboard. The surface includes operational endpoints for daily front-of-house work and analytics endpoints for owner-level reporting.

## For AI agents

Manage fitness studio bookings, attendances, customers, classes, memberships, payments, and communications across the TeamUp platform.

## Scope

Does not handle wearable device data, payroll, or general CRM outside the studio context - use for fitness and wellness studio operations only.

## Capabilities

- Book a customer into a class or appointment and record their attendance
- Sell or renew a membership and apply discounts or vouchers at checkout
- Charge a customer card on file or process a refund against an existing payment
- Manage class schedules, instructors, locations, and offering types
- Send transactional and marketing communications to customers and leads
- Pull business advisor reports and AI-driven content for owner dashboards
- Authenticate via password login, two-factor verification, or refresh-token flow

## Use cases

### Studio Front-of-House Automation

Drive the daily check-in flow at a fitness studio: list today's classes, mark attendances, sell drop-ins or class packs, and accept payment. The /attendances and /availability_schedule_offering_types endpoints power the front desk app, while `/auth/password_login` and refresh-token flows keep staff sessions secure across shifts.

Example prompt: Mark attendance for customer id 7788 in class id 33221, charge their saved card for 18.00 USD if no class pack credit is available, and email a receipt.

### Membership Lifecycle Management

Sell, renew, freeze, and cancel memberships through dedicated endpoints, including discount and voucher application at the point of sale. Recurring membership renewals run on the TeamUp side and surface via the API for downstream reconciliation, while churn signals can be pulled into the owner's BI tool for retention analysis.

Example prompt: Sell membership product 'Unlimited-Monthly' to customer id 5544 starting today, apply voucher 'WELCOME10', and confirm the first payment was successful.

### Marketing and Customer Communications

Use the communications endpoints to send class reminders, win-back campaigns, and transactional receipts to customers and leads. Combined with attendance and membership history, the studio can target lapsed members or upsell premium offerings without leaving TeamUp.

Example prompt: Send a personalised win-back email to all customers whose last attendance was more than 30 days ago and offer a 20% discount voucher.

### AI Agent Owner Reporting

An AI agent runs nightly to fetch business advisor reports and AI content from `/ai/business_advisor_reports`, summarises key trends, and emails the owner. Through Jentic, the agent discovers the right endpoint by intent and uses a vault-stored token, so the studio's TeamUp credentials never appear in the agent's prompt.

Example prompt: Generate a business advisor report for last month, fetch its content via `/ai/business_advisor_reports/{id}/content`, and email a 5-bullet summary to the owner.

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/auth/password_login` | Sign in with email and password |
| POST | `/auth/refresh_access_token` | Refresh an expired access token |
| GET | `/attendances` | List class attendances |
| POST | `/attendances` | Create an attendance for a customer |
| GET | `/applications` | List integration applications |
| GET | `/ai/business_advisor_reports` | List AI business advisor reports |
| GET | `/availability_schedule_offering_types` | List availability schedule offering types |

## Key resources

- **Attendances** — Record class attendance and cancellations
- **Classes and Schedules** — Class definitions, schedules, instructors, and locations
- **Customers** — Customer profiles, contact details, and history
- **Memberships and Payments** — Sell, renew, charge, and refund memberships and one-off purchases
- **Communications** — Send transactional and marketing messages
- **Auth** — Password login, two-factor, refresh-token flows
- **AI Business Advisor** — Generate and retrieve AI-driven owner reports

## Why Jentic

- **Setup:** Wiring the TeamUp REST API by hand means implementing its bearer auth, managing the password login and access-token refresh cycle yourself, and mapping a large operation surface across studio resources. Through Jentic you install once, import TeamUp from the API Directory, store the token once, and your agent calls it while Jentic handles the refresh.
- **Permission scoping:** You choose which TeamUp operations the agent may call, so you can limit it to the operations it needs, such as reading attendances or listing offering types, and leave write operations out of the allowed set. Since the rule is scoped to the operations you pick, the agent cannot reach anything you have not included.
- **Credential handling:** Your TeamUp token is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'record a class attendance' or 'list studio offering types', and Jentic returns the matching TeamUp operation with its input schema so the agent calls the right endpoint without scanning the full resource list.

## Related APIs

- **Mindbody** — Wellness booking platform with broader directory and consumer marketplace
- **Acuity Scheduling** — General-purpose appointment scheduling beyond fitness
- **Calendly** — Lightweight scheduling for trial classes or owner meetings

## FAQ

### Why is there no official OpenAPI spec for TeamUp REST API?

TeamUp does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call TeamUp REST API via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer.

### What authentication does the TeamUp REST API use?

Either JWT bearer authentication or token authentication, sent in the Authorization header. Tokens are obtained from `/auth/password_login` (with optional `/auth/two_factor` flows) and refreshed via `/auth/refresh_access_token.` Through Jentic, the credentials and refresh token live in the encrypted vault.

### Can I book a customer into a class with the TeamUp API?

Yes. POST /attendances with the customer id and the class instance id. The endpoint deducts a class pass credit if available, otherwise it returns the price to charge. The DELETE counterpart cancels the attendance and refunds the credit per the studio's policy.

### How do I sell or renew a membership with the TeamUp REST API?

TeamUp's membership endpoints accept the customer id, membership product id, optional voucher code, and start date. The API returns the new membership object and the resulting payment record, which can then be charged against a saved card or handled in person.

### How do I integrate the TeamUp REST API with an AI agent through Jentic?

Run pip install jentic, search 'book a class attendance' to find POST /attendances, load the schema, and execute. For owner reporting, search 'business advisor report' to find the AI endpoints. Get started with Jentic One, the self-hosted execution layer.

### Can I limit what my agent is allowed to do with the TeamUp REST API?

Yes. Because you run Jentic One yourself, your own rules decide which TeamUp operations and credentials the agent may use. You can restrict it to only the operations it needs, such as GET /attendances and GET /availability_schedule_offering_types, and leave write operations like POST /attendances or membership charges out of the allowed set. Since the agent can only call the operations you include, it cannot reach anything you have not permitted.