> ## 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 Pix Entries

> Use this endpoint to list all Pix entries for an account with optional filters. Returns empty array [] if no entries match the criteria.



## OpenAPI

````yaml /pt/openapi/v3-current/indirect-pix.yaml get /v1/dict/entries
openapi: 3.1.0
info:
  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.
  title: Pix BTG API
  version: 1.12.0
servers:
  - url: https://api.example.com
    description: >-
      Replace the example host with the URL provided during environment
      onboarding.
security:
  - BearerAuth: []
paths:
  /v1/dict/entries:
    get:
      tags:
        - Entries
      summary: List All Pix Entries
      description: >-
        Use this endpoint to list all Pix entries for an account with optional
        filters. Returns empty array [] if no entries match the criteria.
      operationId: dict-get-all-entries
      parameters:
        - description: Account ID (UUID format) - required
          in: header
          name: X-Account-Id
          required: true
          schema:
            description: Account ID (UUID format) - required
            format: uuid
            type: string
        - 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: 10, range: 1-100)'
          explode: false
          in: query
          name: limit
          schema:
            default: 10
            description: 'Maximum number of items per page (default: 10, 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 key value (e.g., email address or phone number)
          explode: false
          in: query
          name: key_value
          schema:
            description: Filter by key value (e.g., email address or phone number)
            type: string
        - description: Filter by entry ID (UUID format)
          explode: false
          in: query
          name: id
          schema:
            description: Filter by entry ID (UUID format)
            format: uuid
            type: string
        - description: >-
            Filter by operational status (comma-separated, OR-matched): ACTIVE,
            INACTIVE
          explode: false
          in: query
          name: status
          schema:
            description: >-
              Filter by operational status (comma-separated, OR-matched):
              ACTIVE, INACTIVE
            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/GetAllEntriesOutput'
          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:
    GetAllEntriesOutput:
      additionalProperties: false
      properties:
        items:
          description: Array of entries for the current page
          items:
            $ref: '#/components/schemas/EntryOutput'
          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 entries matching the filters (across all pages)
          examples:
            - 42
          format: int64
          type: integer
      required:
        - items
        - page
        - limit
        - total
      type: object
    LegacyErrorBody:
      additionalProperties: false
      properties:
        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
        code:
          type: string
        title:
          type: string
      required:
        - code
        - title
        - message
      type: object
    EntryOutput:
      additionalProperties: false
      properties:
        account:
          $ref: '#/components/schemas/AccountOutput'
          description: Account information associated with this Pix key
        createdAt:
          description: Timestamp when the entity was created
          examples:
            - '2024-01-15T10:30:00Z'
          format: date-time
          type: string
        holderId:
          description: Unique identifier of the customer who owns this Pix key
          examples:
            - 550e8400-e29b-41d4-a716-446655440001
          type: string
        id:
          description: Unique identifier of the Pix key entry
          examples:
            - 550e8400-e29b-41d4-a716-446655440010
          type: string
        keyCreationDate:
          description: Date when this Pix key was created on DICT
          examples:
            - '2024-01-15T10:30:00Z'
          format: date-time
          type: string
        keyOwnershipDate:
          description: Date when the customer became the owner of this Pix key
          examples:
            - '2024-01-15T10:30:00Z'
          format: date-time
          type: string
        keyType:
          description: Type of Pix key that was created
          enum:
            - EMAIL
            - PHONE
            - CPF
            - CNPJ
            - EVP
          examples:
            - EMAIL
          type: string
        keyValue:
          description: Pix key value that was registered
          examples:
            - john.doe@example.com
          type: string
        metadata:
          additionalProperties: {}
          description: Custom key-value attributes associated with this entry
          type: object
        owner:
          $ref: '#/components/schemas/OwnerOutput'
          description: Owner information associated with this Pix key
        requestId:
          description: Unique identifier for this creation request (for idempotency)
          examples:
            - 680e8400-e29b-41d4-a716-446655440002
          type: string
        status:
          description: Operational status of this Pix key
          enum:
            - ACTIVE
            - INACTIVE
          examples:
            - ACTIVE
          type: string
        updatedAt:
          description: Timestamp when the entity was last updated
          examples:
            - '2024-01-20T14:45:00Z'
          format: date-time
          type: string
      required:
        - id
        - keyValue
        - keyType
        - account
        - owner
        - holderId
        - keyCreationDate
        - keyOwnershipDate
        - requestId
        - status
        - createdAt
        - updatedAt
      type: object
    AccountOutput:
      additionalProperties: false
      properties:
        branch:
          description: Bank branch code where the account is held (4 digits)
          examples:
            - '0001'
          type: string
        id:
          description: Unique identifier of the customer account
          examples:
            - 550e8400-e29b-41d4-a716-446655440000
          type: string
        number:
          description: >-
            Unique account number at the institution, as sent to DICT: 1-20
            uppercase letters or digits, ending in a digit
          examples:
            - '123456789'
          type: string
        openingDate:
          description: Date when the account was opened
          examples:
            - '2020-01-15T10:30:00Z'
          format: date-time
          type: string
        participant:
          description: >-
            ISPB of the participant institution (8 uppercase alphanumeric
            characters)
          examples:
            - '12345678'
          type: string
        type:
          description: Kind of account holding this Pix key
          enum:
            - CACC
            - SLRY
            - SVGS
            - TRAN
            - OTHR
          examples:
            - TRAN
          type: string
      required:
        - id
        - participant
        - branch
        - number
        - type
        - openingDate
      type: object
    OwnerOutput:
      additionalProperties: false
      properties:
        document:
          description: Identification document of the account owner (CPF or CNPJ)
          examples:
            - '52998224725'
          type: string
        name:
          description: Full name or registered name of the account owner
          examples:
            - John Doe
          type: string
        tradeName:
          description: Business trade name or commercial alias
          examples:
            - John's Business
          type: string
        type:
          description: Whether the account owner is a person or organization
          enum:
            - NATURAL_PERSON
            - LEGAL_PERSON
          examples:
            - NATURAL_PERSON
          type: string
      required:
        - type
        - document
        - name
        - tradeName
      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.