> ## Documentation Index
> Fetch the complete documentation index at: https://sure-917046f5-docs-cloudflare-tunnel-self-hosting.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Trigger sync

> Queues a full family sync that applies all active rules, syncs all accounts, and auto-matches transfers.



## OpenAPI

````yaml /openapi.yaml post /api/v1/sync
openapi: 3.0.3
info:
  title: Sure API
  version: v1
  description: OpenAPI documentation for the Sure API.
servers:
  - url: https://app.sure.am
    description: Production
  - url: http://localhost:3000
    description: Local development
security: []
paths:
  /api/v1/sync:
    post:
      tags:
        - Sync
      summary: Trigger sync
      description: >-
        Queues a full family sync that applies all active rules, syncs all
        accounts, and auto-matches transfers.
      responses:
        '202':
          description: sync queued
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SyncJobResponse'
      security:
        - apiKeyAuth: []
components:
  schemas:
    SyncJobResponse:
      type: object
      required:
        - id
        - status
        - syncable_type
        - syncable_id
        - message
      properties:
        id:
          type: string
          format: uuid
        status:
          type: string
          description: Current sync status
        syncable_type:
          type: string
        syncable_id:
          type: string
          format: uuid
        syncing_at:
          type: string
          format: date-time
          nullable: true
        completed_at:
          type: string
          format: date-time
          nullable: true
        window_start_date:
          type: string
          format: date
          nullable: true
        window_end_date:
          type: string
          format: date
          nullable: true
        message:
          type: string
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      name: X-Api-Key
      in: header
      description: API key for authentication. Generate one from your account settings.

````