> ## Documentation Index
> Fetch the complete documentation index at: https://openwearables.io/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Sync Historical Data

> Trigger a historical sync of the user's data from a connected provider.

Each provider strategy decides how to dispatch the sync (REST polling,
webhook backfill, etc.). The ``days`` parameter may be ignored by
providers that enforce their own limits.

**Automatic historical sync on connect (grace period)**

v0.4.2 introduced this endpoint as the canonical, opt-in way to
backfill historical data - the long-term goal is that connecting a
provider only sets up live sync, and history is pulled on demand.

To make migration painless, the pre-0.4.2 behaviour is kept for now
behind a grace-period flag (``HISTORICAL_SYNC_ON_CONNECT``, default:
``true``): a historical sync is auto-dispatched after a successful
OAuth callback (up to 90 days for pull-based providers; up to 30
days for Garmin, whose webhook-based backfill is capped at 30 days
from the user's consent date).

Once your integration calls this endpoint explicitly, set
``HISTORICAL_SYNC_ON_CONNECT=false``. The flag will default to
``false`` in a future release and is planned for removal afterwards.



## OpenAPI

````yaml https://api.openwearables.io/openapi.json post /api/v1/providers/{provider}/users/{user_id}/sync/historical
openapi: 3.1.0
info:
  title: Open Wearables API
  version: 0.1.0
servers: []
security: []
paths:
  /api/v1/providers/{provider}/users/{user_id}/sync/historical:
    post:
      tags:
        - 'External: Data Sync'
      summary: Sync Historical Data
      description: |-
        Trigger a historical sync of the user's data from a connected provider.

        Each provider strategy decides how to dispatch the sync (REST polling,
        webhook backfill, etc.). The ``days`` parameter may be ignored by
        providers that enforce their own limits.

        **Automatic historical sync on connect (grace period)**

        v0.4.2 introduced this endpoint as the canonical, opt-in way to
        backfill historical data - the long-term goal is that connecting a
        provider only sets up live sync, and history is pulled on demand.

        To make migration painless, the pre-0.4.2 behaviour is kept for now
        behind a grace-period flag (``HISTORICAL_SYNC_ON_CONNECT``, default:
        ``true``): a historical sync is auto-dispatched after a successful
        OAuth callback (up to 90 days for pull-based providers; up to 30
        days for Garmin, whose webhook-based backfill is capped at 30 days
        from the user's consent date).

        Once your integration calls this endpoint explicitly, set
        ``HISTORICAL_SYNC_ON_CONNECT=false``. The flag will default to
        ``false`` in a future release and is planned for removal afterwards.
      operationId: >-
        sync_historical_data_api_v1_providers__provider__users__user_id__sync_historical_post
      parameters:
        - name: provider
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/ProviderName'
            description: Data provider
          description: Data provider
        - name: user_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
            title: User Id
        - name: days
          in: query
          required: false
          schema:
            type: integer
            maximum: 365
            minimum: 1
            description: >-
              Days of historical data to fetch (default: 90, max: 365). Ignored
              for providers with their own limits (e.g. Garmin: 30 days).
            default: 90
            title: Days
          description: >-
            Days of historical data to fetch (default: 90, max: 365). Ignored
            for providers with their own limits (e.g. Garmin: 30 days).
        - name: X-Open-Wearables-API-Key
          in: header
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: X-Open-Wearables-Api-Key
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: >-
                  Response Sync Historical Data Api V1 Providers  Provider 
                  Users  User Id  Sync Historical Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - OAuth2PasswordBearer: []
components:
  schemas:
    ProviderName:
      type: string
      enum:
        - apple
        - samsung
        - google
        - garmin
        - polar
        - suunto
        - whoop
        - strava
        - oura
        - fitbit
        - ultrahuman
        - unknown
        - internal
      title: ProviderName
      description: Supported data providers.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    OAuth2PasswordBearer:
      type: oauth2
      flows:
        password:
          scopes: {}
          tokenUrl: /api/v1/auth/login

````