client_id and client_secret at the token endpoint, then call API resources
with a Bearer token.
Setting up for the first time? The Quickstart walks
through credential creation, token exchange, and a first call step by step.
/public/v1/access/* uses a separate device-key contract for gates and
scanners. It does not use OAuth scopes or fspt_... Bearer tokens. See
Access Devices for x-device-key authentication.1. Create an OAuth client
Have an authorized company administrator create OAuth credentials for your integration. The company must have Public API access. See the Quickstart for credential setup in the coach dashboard. The OAuth client configuration identifies the integration, its granted scopes, its optional default assigned coach, and the accepted data consents. For example:clientSecret) is shown once. Store it securely.
For externally managed app access, create the OAuth client with
externalAppAccessEnabled: true and include client_app_access:write in its
configured scopes. The default is false; this setting does not take over
existing manual relationships. See the complete company opt-in example.
Consent-gated scopes
Some scopes expose health data or private communication. Granting them requires an explicit consent in the optionalconsents object:
- Scopes marked
requiresConsent: "health"in the scope catalog (measurements, progress summaries and photos, intakes, checkups, form assignments, habits, goals, documents) require"consents": { "healthData": true }. Otherwise creation fails with400 PUBLIC_API_HEALTH_CONSENT_REQUIRED. - Scopes marked
requiresConsent: "private_communication"(messages, client notes) require"consents": { "privateCommunication": true }. Otherwise creation fails with400 PUBLIC_API_PRIVATE_COMM_CONSENT_REQUIRED.
403 scopes.health_consent_required or
403 scopes.private_communication_consent_required on consent-gated endpoints,
even when the scope itself was granted. GET /public/v1/scopes marks each
consent-gated scope with a requiresConsent field.
2. Request an access token
Exchange the client credentials for an access token:scope is omitted, FITsociety issues all scopes assigned to the client.
Requested scopes must be a subset of the client’s assigned scopes.
Current company access
Each resource request requires current access for the integration and company bound to the token. Disabling company access blocks the next request with403 auth.provider_unavailable, including requests with an unexpired token.
Re-enabling access allows otherwise valid tokens to work again.
Revoking an OAuth client cannot be undone and returns
401 auth.invalid_client (or 401 auth.invalid_token for revoked tokens).
Available scopes
3. Call a resource
Use the access token in theAuthorization header:
Idempotency-Key header. Reuse the same key
only when retrying the exact same request.
Token lifetime
Rotating a client secret revokes existing access tokens for that client.