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

# List transfers for a given destination

> Retrieve list of transfers.



## OpenAPI

````yaml /generated/openapi-generated-2023-12-01.json get /destinations/{destination_id}/transfers
openapi: 3.1.0
info:
  title: Prequel Data Export
  description: Data Export API spec
  version: '2023-12-01'
servers:
  - url: https://api.prequel.co
    description: Cloud-hosted server (US)
  - url: https://eu-api.prequel.co
    description: Cloud-hosted server (EU)
  - url: https://{custom_host}/
    description: Cloud-prem or shared-cloud server
security:
  - ApiKeyAuth: []
paths:
  /destinations/{destination_id}/transfers:
    get:
      tags:
        - Transfers
      summary: List transfers for a given destination
      description: Retrieve list of transfers.
      operationId: list-transfers-for-destination
      parameters:
        - name: destination_id
          in: path
          required: true
          description: Destination ID.
          schema:
            type: string
        - name: status
          in: query
          required: false
          description: Status of the transfer.
          schema:
            type: string
        - name: include_tags
          in: query
          required: false
          description: Filter transfers by comma-separated key.value pairs.
          schema:
            type: string
        - name: ended_before
          in: query
          required: false
          description: >-
            Filter transfers with ended_at less than (exclusive) this RFC3339
            timestamp.
          schema:
            type: string
        - name: ended_after
          in: query
          required: false
          description: >-
            Filter transfers with ended_at greater than or equal to (inclusive)
            this RFC3339 timestamp.
          schema:
            type: string
        - name: page_size
          in: query
          required: false
          description: Number of items to return per page.
          schema:
            type: integer
        - name: order
          in: query
          required: false
          description: Sort order for items
          schema:
            type: string
            enum:
              - asc
              - desc
        - name: cursor
          in: query
          required: false
          description: >-
            Used for pagination - represents last page seen. Value is included
            in response when there is a next page.
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                properties:
                  status:
                    type: string
                    const: success
                  data:
                    $ref: '#/components/schemas/ListTransferResponse'
                    $schema: https://json-schema.org/draft/2020-12/schema
                    $id: >-
                      https://github.com/prequel-co/datafeed/internal/export/api/models/list-transfer-response
                  message:
                    type: string
                  has_next:
                    type: boolean
                    description: Whether there are more items beyond this page.
                  next_url:
                    type: string
                    description: >-
                      Full URL to fetch the next page. Only present when
                      has_next is true.
                type: object
                required:
                  - status
                  - data
                  - message
                  - has_next
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
      security:
        - ApiKeyAuth: []
components:
  schemas:
    ListTransferResponse:
      properties:
        transfers:
          items:
            $ref: '#/components/schemas/Transfer'
          type: array
      additionalProperties: false
      type: object
      required:
        - transfers
    Transfer:
      properties:
        id:
          type: string
          description: Unique identifier for the transfer.
        source_ids:
          items:
            type: string
          type: array
          description: IDs of the sources used in this transfer.
        destination_id:
          type: string
          description: ID of the destination this transfer wrote to.
        status:
          type: string
          enum:
            - PENDING
            - RUNNING
            - SUCCESS
            - PARTIAL_FAILURE
            - ERROR
            - CANCELLED
            - KILLED
            - EXPIRED
            - ORPHANED
          description: Current status of the transfer.
        is_full_refresh:
          type: boolean
          description: >-
            Whether this transfer was a full refresh (true) or incremental
            (false).
        models:
          items:
            type: string
          type: array
          description: Names of the models included in this transfer.
        model_metrics:
          items:
            $ref: '#/components/schemas/ModelMetrics'
          type: array
          description: Per-model object of results including row counts and any errors.
        log:
          type: string
          description: Plain text description of the model results.
        submitted_at:
          type: string
          format: date-time
          description: When the transfer was submitted to the queue.
        start_transfer_window_at:
          type: string
          format: date-time
          description: Start of the transfer window.
        end_transfer_window_at:
          type: string
          format: date-time
          description: End of the transfer window.
        started_at:
          type: string
          format: date-time
          description: When the transfer began executing.
        ended_at:
          type: string
          format: date-time
          description: When the transfer finished executing.
        rows_transferred:
          type: integer
          description: Total number of rows written to the destination across all models.
        delta_rows_transferred:
          type: integer
          description: Estimate of net change in row count at the destination.
        volume_transferred_in_mb:
          type: number
          description: Total data volume written to the destination in megabytes.
        tags:
          additionalProperties:
            type: string
          type: object
          description: Arbitrary key-value string tags attached to the transfer.
        actor_id:
          type: string
          description: ID of the actor that triggered this transfer.
        actor_type:
          type: string
          enum:
            - unknown
            - user
            - api_key
            - service
            - recipient
          description: Type of actor that triggered this transfer.
      additionalProperties: false
      type: object
      required:
        - id
        - status
        - is_full_refresh
        - models
        - log
        - submitted_at
        - start_transfer_window_at
        - end_transfer_window_at
        - rows_transferred
        - delta_rows_transferred
        - volume_transferred_in_mb
        - actor_id
        - actor_type
    ErrorResponse:
      properties:
        status:
          type: string
          const: error
        message:
          type: string
        data:
          type: 'null'
      type: object
      required:
        - status
        - message
    ModelMetrics:
      properties:
        model_id:
          type: string
          description: Unique identifier for the model.
        model_name:
          type: string
          description: Name of the model.
        rows_transferred:
          type: integer
          description: Number of rows written to the destination for this model.
        delta_rows_transferred:
          type: integer
          description: >-
            Net change in row count at the destination for this model (inserts
            minus deletes).
        volume_transferred_in_mb:
          type: number
          description: Data volume written to the destination for this model in megabytes.
        start_transfer_window_at:
          type: string
          format: date-time
          description: Start of the incremental window this model extracted data from.
        end_transfer_window_at:
          type: string
          format: date-time
          description: End of the incremental window this model extracted data from.
        most_recent_last_updated_at:
          type: string
          format: date-time
          description: >-
            The most recent updated_at value seen in the source data for this
            model during this transfer.
        error:
          $ref: '#/components/schemas/CodedError'
          description: >-
            Structured error details if this model failed. Null if the model
            succeeded or was skipped.
      additionalProperties: false
      type: object
      required:
        - model_id
        - rows_transferred
        - delta_rows_transferred
        - volume_transferred_in_mb
        - start_transfer_window_at
        - end_transfer_window_at
        - most_recent_last_updated_at
        - error
    CodedError:
      properties:
        error: true
        error_code:
          type: string
          description: >-
            A unique Prequel error code in the format PRQL-XXXX identifying the
            specific error type.
        title:
          type: string
          description: Short human-readable label for the error.
        blame:
          type: string
          description: 'Who is responsible for the error. One of: first_party'
        documentation_url:
          type: string
          description: Link to Prequel documentation for this specific error code.
        trace:
          type: string
          description: Raw error trace.
        message:
          type: string
          description: User-facing explanation of the error and how to resolve it.
      additionalProperties: false
      type: object
      required:
        - error
        - error_code
        - title
        - blame
        - documentation_url
        - trace
        - message
  responses:
    BadRequest:
      description: Bad Request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Unauthorized:
      description: Unauthorized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    NotFound:
      description: Not Found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    InternalServerError:
      description: Internal Server Error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-KEY

````