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

# Trigger a full family sync

> Enqueues a background job that applies all active rules, syncs all connected accounts, and auto-matches transfers for the authenticated user's family. Returns HTTP 202 Accepted with the queued sync object. Requires write scope.




## OpenAPI

````yaml /openapi.yaml post /api/v1/sync
openapi: 3.0.3
info:
  title: Sure API
  version: v1
  description: OpenAPI documentation generated from executable request specs.
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 a full family sync
      description: >
        Enqueues a background job that applies all active rules, syncs all
        connected accounts, and auto-matches transfers for the authenticated
        user's family. Returns HTTP 202 Accepted with the queued sync object.
        Requires write scope.
      responses:
        '202':
          description: sync queued
          content:
            application/json:
              schema:
                type: object
                required:
                  - id
                  - status
                  - message
                properties:
                  id:
                    type: string
                    format: uuid
                  status:
                    type: string
                    example: pending
                  syncable_type:
                    type: string
                    nullable: true
                  syncable_id:
                    type: string
                    format: uuid
                    nullable: true
                  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
                    example: Sync has been queued and will apply all active rules
        '401':
          description: unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: insufficient scope
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - apiKeyAuth: []
        - bearerAuth: []
components:
  schemas:
    ErrorResponse:
      type: object
      required:
        - error
      properties:
        error:
          type: string
        message:
          type: string
          nullable: true
        details:
          oneOf:
            - type: array
              items:
                type: string
            - type: object
          nullable: true
        errors:
          type: array
          items:
            type: string
          nullable: true
          description: >-
            Validation error messages (alternative to details used by trades,
            valuations, etc.)
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      name: X-Api-Key
      in: header
      description: API key for authentication. Generate one from your account settings.
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        OAuth2 Bearer token. Obtain a token from the /api/v1/auth/login or
        /api/v1/auth/refresh endpoints. The token must have the 'read' or
        'read_write' scope.

````