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

# List All VSync States

> Use this endpoint to list all VSync states for PIX key types with optional filters.
Returns empty array [] if no VSync states match the criteria.
Note: This table has at most 5 records (one per PIX key type: CPF, CNPJ, EMAIL, PHONE, EVP).



## OpenAPI

````yaml /pt/openapi/v3-current/indirect-pix.yaml get /v1/dict/vsync
openapi: 3.1.0
info:
  contact:
    email: contact@lerian.studio
    name: Lerian Studio
    url: https://lerian.studio
  description: >-
    API for Pix Indirect via BTG. It covers DICT keys and claims; MED infraction
    reports, fraud markers, refund requests, and funds recoveries; DICT
    statistics and reconciliation; Pix transfers, refunds, and schedules; static
    QR codes and QR code decoding; immediate and due-date collections; Pix
    Automático for the payer; transaction reports and TemposTransacoes
    statistics; and inbound and outbound webhook records.
  license:
    name: Lerian Studio General License
  title: Pix BTG API
  version: 1.14.0
servers:
  - url: https://api.example.com
    description: >-
      Replace the example host with the URL provided during environment
      onboarding.
security:
  - BearerAuth: []
paths:
  /v1/dict/vsync:
    get:
      tags:
        - Reconciliation
      summary: List All VSync States
      description: >-
        Use this endpoint to list all VSync states for PIX key types with
        optional filters.

        Returns empty array [] if no VSync states match the criteria.

        Note: This table has at most 5 records (one per PIX key type: CPF, CNPJ,
        EMAIL, PHONE, EVP).
      operationId: dict-get-all-vsync-states
      parameters:
        - description: 'Page number for pagination (default: 1, minimum: 1)'
          explode: false
          in: query
          name: page
          schema:
            default: 1
            description: 'Page number for pagination (default: 1, minimum: 1)'
            format: int64
            type: integer
        - description: 'Maximum number of items per page (default: 5, range: 1-100)'
          explode: false
          in: query
          name: limit
          schema:
            default: 5
            description: 'Maximum number of items per page (default: 5, range: 1-100)'
            format: int64
            type: integer
        - description: 'Filter by key type: CPF, CNPJ, EMAIL, PHONE, EVP'
          explode: false
          in: query
          name: key_type
          schema:
            description: 'Filter by key type: CPF, CNPJ, EMAIL, PHONE, EVP'
            type: string
        - description: >-
            Filter by sync status (comma-separated, OR-matched): SYNCED,
            OUT_OF_SYNC, RECONCILING, ERROR
          explode: false
          in: query
          name: status
          schema:
            description: >-
              Filter by sync status (comma-separated, OR-matched): SYNCED,
              OUT_OF_SYNC, RECONCILING, ERROR
            items:
              type: string
            type: array
        - description: 'Sort direction: asc or desc (default: asc)'
          explode: false
          in: query
          name: sort_order
          schema:
            description: 'Sort direction: asc or desc (default: asc)'
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAllVSyncStatesOutput'
          description: OK
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LegacyErrorBody'
          description: Bad Request
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LegacyErrorBody'
          description: Internal Server Error
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LegacyErrorBody'
          description: Error
components:
  schemas:
    GetAllVSyncStatesOutput:
      additionalProperties: false
      properties:
        items:
          description: Array of VSync states for the current page
          items:
            $ref: '#/components/schemas/VSyncStateOutput'
          type: array
        limit:
          description: Number of items per page
          examples:
            - 10
          format: int64
          type: integer
        page:
          description: Current page number
          examples:
            - 1
          format: int64
          type: integer
        total:
          description: Total number of VSync states matching the filters
          examples:
            - 5
          format: int64
          type: integer
      required:
        - items
        - page
        - limit
        - total
      type: object
    LegacyErrorBody:
      additionalProperties: false
      properties:
        code:
          type: string
        fields:
          additionalProperties:
            type: string
          type: object
        headers:
          additionalProperties:
            type: string
          type: object
        message:
          type: string
        paths:
          additionalProperties:
            type: string
          type: object
        queryParams:
          additionalProperties:
            type: string
          type: object
        raw:
          type: string
        title:
          type: string
      required:
        - code
        - title
        - message
      type: object
    VSyncStateOutput:
      additionalProperties: false
      properties:
        createdAt:
          description: When this VSync state record was created (ISO 8601 UTC)
          examples:
            - '2024-01-15T10:30:00Z'
          format: date-time
          type: string
        id:
          description: Unique identifier for this VSync state (UUID v7)
          examples:
            - 0192c3a4-5b6d-7e8f-9a0b-1c2d3e4f5a6b
          type: string
        keyType:
          description: PIX key type for this VSync state (CPF, CNPJ, EMAIL, PHONE, EVP)
          examples:
            - CPF
          type: string
        lastCidCreatedAt:
          description: Creation timestamp of the last CID processed (ISO 8601 UTC)
          examples:
            - '2024-01-15T10:30:00Z'
          format: date-time
          type: string
        lastFullReconciliation:
          description: When the last full reconciliation was performed (ISO 8601 UTC)
          examples:
            - '2024-01-15T10:30:00Z'
          format: date-time
          type: string
        lastSyncCheck:
          description: When the last sync check was performed with BTG (ISO 8601 UTC)
          examples:
            - '2024-01-15T10:30:00Z'
          format: date-time
          type: string
        lastSyncStatus:
          description: >-
            Current synchronization status (SYNCED, OUT_OF_SYNC, RECONCILING,
            ERROR)
          examples:
            - SYNCED
          type: string
        lastSyncTimestamp:
          description: When the local VSync was last calculated (ISO 8601 UTC)
          examples:
            - '2024-01-15T10:30:00Z'
          format: date-time
          type: string
        localVSync:
          description: Local VSync value (64 hex characters)
          examples:
            - '0000000000000000000000000000000000000000000000000000000000000000'
          type: string
        updatedAt:
          description: When this VSync state record was last updated (ISO 8601 UTC)
          examples:
            - '2024-01-15T10:30:00Z'
          format: date-time
          type: string
      required:
        - id
        - keyType
        - localVSync
        - lastSyncStatus
        - createdAt
        - updatedAt
      type: object
  securitySchemes:
    BearerAuth:
      bearerFormat: JWT
      description: JWT bearer token issued by the identity provider.
      scheme: bearer
      type: http

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.