Getting started

The Uptivo Club API is designed for server-to-server integrations. When the club license enables Club API, the credentials are available from the club profile’s Club API tab. When needed, Uptivo can provide a test club for integration work.

Before you start

You need:

• Club API access enabled in the club’s Uptivo license. See Uptivo Open API for availability and activation;
• a Subscription Key for your integration;
• a Club Token (called Club API Key in the API reference) for the club you want to access;
• an HTTP client such as curl, Postman, or your preferred programming language.

Both credentials are required on every request. Read Manage Club API access to obtain them, then read Authentication before storing or sending them.

Make the first request

Request the selected club profile:

curl --request GET \
  --url https://api-gw.uptivo.fit/club/Profile \
  --header "X-Sub-Key: <subscription-key>" \
  --header "Authorization: Bearer <club-api-key>"

A successful response returns the profile of the club selected by the Club API Key. This abbreviated example shows the fields needed to verify the scope:

{
  "ClubId": 100001,
  "ClubCode": "EXAMPLE",
  "Name": "Example Fitness Club",
  "CountryCode": "IT",
  "TimeZoneCode": "Europe/Rome",
  "DefaultCurrency": "eur"
}

Confirm that the returned ClubId and Name identify the club you intended to access before performing write operations.

Caution

The values above are placeholders. Do not paste real credentials into source code, tickets, chat messages, or browser-based tools you do not control.

PowerShell

Use environment variables so the credentials do not appear in the script:

$headers = @{
  'X-Sub-Key' = $env:UPTIVO_SUBSCRIPTION_KEY
  Authorization = "Bearer $env:UPTIVO_CLUB_API_KEY"
  Accept = 'application/json'
}

$club = Invoke-RestMethod `
  -Method Get `
  -Uri 'https://api-gw.uptivo.fit/club/Profile' `
  -Headers $headers

$club | Select-Object ClubId, Name, TimeZoneCode

Run the request only from a trusted server or development machine. Do not put either credential in code shipped to a browser or mobile application.

If the request fails

• For 401 Unauthorized, check that both headers are present and that neither credential has been rotated, revoked, or copied incorrectly.
• For 403 Forbidden, check that the club has an active Club API license and that the Club API Key grants the access level required by the operation.

Do not retry either response with unchanged credentials. See Errors for response formats, domain conflicts, and retry guidance.

Import the OpenAPI contract

Download the generated specification and import it into Postman or another OpenAPI-compatible client:

Download the Club API OpenAPI document

The document already declares the production server and both required security schemes.

Continue the integration

1. Learn how to construct requests, JSON, and dates.
2. Plan pagination and synchronization.
3. Follow the Club, Contacts, Athletes, Trainings, Telemetry, Subscriptions, and User subscriptions workflows, then continue with Classes and calendars, Class participants, and Challenges and results.
4. Review the data model.
5. Browse the interactive API reference.
6. Implement the error-handling strategy.
7. Configure webhook subscriptions and implement a reliable event receiver.
8. Check the changelog before releasing an update.
9. Use the glossary when mapping Uptivo terms to your domain.