Skip to content

Glossary

Use these terms consistently when designing and discussing an integration. Exact property names and enum values retain the casing shown in the API reference.

Term Meaning
Athlete The relationship between an Uptivo User and a Club. Removing an Athlete from a Club does not delete the global User account.
Badge award One award of a badge to an Athlete, identified by AchievedBadgeId. BadgeId identifies the reusable design, not the individual award.
Class A scheduled activity exposed through a Club, PT, or Services calendar.
ClassParticipant The association between an Athlete and a Class, including attendance mode, queue state, and payment consumption.
Club The organization and data scope selected by the Club Token.
Club API Key The name used by the OpenAPI contract for the Club Token.
Club Token The Bearer credential that selects a Club and grants Read or ReadWrite access. Integrations must treat it as an opaque secret.
Commercial stage The club-specific ClientStage of an Athlete or Contact: Lead, Qualified, Prospect, or Client. It is not a global User profile field.
Contact A non-demo Uptivo User associated with a Club without an Athlete membership there. Contact data does not grant access to that User’s training or engagement data.
Membership summary The effective state calculated from all of an Athlete’s club UserSubscriptions, including their assignment details. It is not another Subscription or a state-change event.
Subscription A commercial membership or activity-package definition configured by a Club. Its schema uses ClassSubscriptionId.
Subscription Key The API gateway credential sent in X-Sub-Key. The Club API page provides primary and secondary values for safe rotation.
Training A completed workout associated with an Uptivo User. It may contain aggregate values and raw telemetry.
User A person with a global Uptivo account. The Club API accesses that person through a club-scoped Athlete or Contact relationship, with different data available for each.
UserSubscription A Subscription assigned to an Athlete for a period and, optionally, a limited number of activities. Its schema uses UserClassSubscriptionId.
Webhook subscription A Club-scoped configuration that tells Uptivo which events to deliver and to which public URL.

See the data model for representative resource shapes and relationships.