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

# Lists sync history

> List sanitized sync status history for the authenticated user's family, accounts, and provider connections.



## OpenAPI

````yaml /openapi.yaml get /api/v1/syncs
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/syncs:
    get:
      tags:
        - Syncs
      summary: Lists sync history
      description: >-
        List sanitized sync status history for the authenticated user's family,
        accounts, and provider connections.
      parameters:
        - name: page
          in: query
          required: false
          description: 'Page number (default: 1)'
          schema:
            type: integer
        - name: per_page
          in: query
          required: false
          description: 'Items per page (default: 25, max: 100)'
          schema:
            type: integer
      responses:
        '200':
          description: syncs listed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SyncCollection'
        '401':
          description: unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - apiKeyAuth: []
components:
  schemas:
    SyncCollection:
      type: object
      required:
        - data
        - meta
      properties:
        data:
          type: array
          maxItems: 100
          items:
            $ref: '#/components/schemas/SyncResource'
        meta:
          $ref: '#/components/schemas/Pagination'
    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.)
    SyncResource:
      type: object
      required:
        - id
        - status
        - in_progress
        - terminal
        - syncable
        - children_count
        - created_at
        - updated_at
      properties:
        id:
          type: string
          format: uuid
        status:
          type: string
          enum:
            - pending
            - syncing
            - completed
            - failed
            - stale
        in_progress:
          type: boolean
        terminal:
          type: boolean
        syncable:
          $ref: '#/components/schemas/SyncableSummary'
        parent_id:
          type: string
          format: uuid
          nullable: true
        children_count:
          type: integer
          minimum: 0
        window_start_date:
          type: string
          format: date
          nullable: true
        window_end_date:
          type: string
          format: date
          nullable: true
        pending_at:
          type: string
          format: date-time
          nullable: true
        syncing_at:
          type: string
          format: date-time
          nullable: true
        completed_at:
          type: string
          format: date-time
          nullable: true
        failed_at:
          type: string
          format: date-time
          nullable: true
        error:
          nullable: true
          allOf:
            - $ref: '#/components/schemas/SyncErrorSummary'
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
    Pagination:
      type: object
      required:
        - page
        - per_page
        - total_count
        - total_pages
      properties:
        page:
          type: integer
          minimum: 1
        per_page:
          type: integer
          minimum: 1
        total_count:
          type: integer
          minimum: 0
        total_pages:
          type: integer
          minimum: 0
    SyncableSummary:
      type: object
      required:
        - type
        - id
      properties:
        type:
          type: string
        id:
          type: string
          format: uuid
        name:
          type: string
          nullable: true
    SyncErrorSummary:
      type: object
      required:
        - message
      properties:
        message:
          type: string
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      name: X-Api-Key
      in: header
      description: API key for authentication. Generate one from your account settings.

````