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

# List transfer history

> Returns a paginated list of miles transfers for the API key owner.



## OpenAPI

````yaml https://api.staging.rovemiles.com/functions/v1/openapi get /miles/transfer/list
openapi: 3.0.3
info:
  title: Rove Miles API
  version: 0.1.0
  description: Data Utils, Flights, Hotels & Miles endpoints.
servers:
  - url: https://api.staging.rovemiles.com/functions/v1
security:
  - bearerAuth: []
tags:
  - name: Data
    description: Operations related to reference data like airports and places
  - name: Flights
    description: Operations related to flight search and booking
  - name: Hotels
    description: Operations related to hotel search and booking
  - name: Miles
    description: Operations related to miles and points management
  - name: Deals
    description: Operations related to special offers and promotions for flights and hotels
paths:
  /miles/transfer/list:
    get:
      tags:
        - Miles
      summary: List transfer history
      description: Returns a paginated list of miles transfers for the API key owner.
      parameters:
        - $ref: '#/components/parameters/LimitParam'
        - $ref: '#/components/parameters/OffsetParam'
        - name: reference_id
          in: query
          required: false
          schema:
            type: string
          description: Filter transfers by reference ID
      responses:
        '200':
          description: Transfer history retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TransferList'
              example:
                data:
                  - transaction_id: 6f2ea869-df09-438e-8264-77f4c0aa4251
                    account_id: a1b2c3d4-e5f6-7890-abcd-ef1234567890
                    amount: 25000
                    created_at: '2023-09-15T14:22:31Z'
                    status: success
                    reference_id: ref_airline_123456
                  - transaction_id: 8a084d3b-3e6d-47b4-b7d3-b753e0645ba1
                    account_id: b2c3d4e5-f6g7-8901-abcd-ef2345678901
                    amount: 10000
                    created_at: '2023-09-12T09:44:17Z'
                    status: success
                    reference_id: ref_cc_789012
                  - transaction_id: 81c7661a-b45a-4a85-bef9-6df02c67eb7e
                    account_id: c3d4e5f6-g7h8-9012-abcd-ef3456789012
                    amount: 5000
                    created_at: '2023-09-08T16:30:45Z'
                    status: success
                    reference_id: ref_promo_345678
                pagination:
                  total: 3
                  limit: 10
                  offset: 0
                  hasMore: false
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '500':
          $ref: '#/components/responses/InternalError'
components:
  parameters:
    LimitParam:
      name: limit
      in: query
      required: false
      schema:
        type: integer
        default: 20
      description: Max items to return
    OffsetParam:
      name: offset
      in: query
      required: false
      schema:
        type: integer
        default: 0
      description: Pagination offset
  schemas:
    TransferList:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Transfer'
        pagination:
          type: object
          properties:
            total:
              type: integer
              description: Total number of transfers
            limit:
              type: integer
              description: Number of results per page
            offset:
              type: integer
              description: Current offset in pagination
            hasMore:
              type: boolean
              description: Whether more results are available
    Transfer:
      type: object
      properties:
        transaction_id:
          type: string
          format: uuid
          description: Unique identifier for the transfer transaction
        account_id:
          type: string
          format: uuid
          description: Account ID of the recipient
        amount:
          type: integer
          description: Amount of miles transferred
        created_at:
          type: string
          format: date-time
          description: Timestamp when the transfer was created
        status:
          type: string
          description: Status of the transfer (success, pending, failed)
        reference_id:
          type: string
          description: Reference ID for the transfer (used for idempotency)
    Error:
      type: object
      properties:
        code:
          type: integer
        message:
          type: string
  responses:
    BadRequest:
      description: Bad Request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            code: 400
            message: Bad Request
    Unauthorized:
      description: Unauthorized - Invalid or missing token
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            code: 401
            message: Unauthorized - Invalid or missing token
    InternalError:
      description: Internal Server Error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            code: 500
            message: Internal Server Error
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: >-
        API key for authentication. Add your API key to the Authorization header
        with this format: 'Bearer your_api_key_here'

````