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

# Download an export

> Generates a pre-signed download URL for a ready export and redirects (`302`) to it. Requires authentication. Guest users may only download exports they own.

Token

**Permission:** requires `reports`.



## OpenAPI

````yaml /api-reference/specs/exports.json get /api/exports/download/{id}
openapi: 3.1.0
info:
  title: ConveYour API — Exports
  description: Download generated data exports and check export status.
  version: 1.0.0
servers:
  - url: https://{subdomain}.conveyour.com
    description: Your organization's ConveYour instance
    variables:
      subdomain:
        default: acme
        description: >-
          Your organization's slug — the subdomain you sign in on. Replace
          `acme` with yours: if you sign in at `bigco.conveyour.com`, enter
          `bigco`.
security:
  - conveyourToken: []
tags:
  - name: Exports
    description: Download generated data exports and check export status.
paths:
  /api/exports/download/{id}:
    get:
      tags:
        - Exports
      summary: Download an export
      description: >-
        Generates a pre-signed download URL for a ready export and redirects
        (`302`) to it. Requires authentication. Guest users may only download
        exports they own.


        Token


        **Permission:** requires `reports`.
      operationId: token
      parameters:
        - name: id
          in: path
          description: The export's ID.
          schema:
            type: string
          required: true
        - $ref: '#/components/parameters/teams'
      responses:
        '302':
          description: >-
            Redirect to a pre-signed download URL. There is no JSON body on
            success. Follow the `Location` header to fetch the bundle.


            The `Location` URL is a **pre-signed S3 (DigitalOcean Spaces) link
            valid for 1 hour**. It serves the stored bundle with
            `Content-Disposition: attachment` and a filename derived from the
            export's name; the extension comes from the stored `bundle_path`
            (falling back to `.bin`). Follow the redirect with a plain GET — do
            not send the `x-conveyour-token` header to the S3 host.
          headers:
            Location:
              description: Pre-signed URL for the export bundle. Short-lived.
              schema:
                type: string
                format: uri
        '400':
          description: No export ID supplied, or the export is not in `ready` status.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Envelope'
              example:
                status: failed
                message: Export is not ready for download
                data: []
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '410':
          description: The export has expired.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Envelope'
              example:
                status: failed
                message: Export has expired
                data: []
        '500':
          description: The pre-signed download URL could not be generated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Envelope'
              example:
                status: failed
                message: Unable to generate download URL
                data: []
components:
  parameters:
    teams:
      name: teams[]
      in: query
      description: >-
        Team scope for the request, as one or more team ObjectIds. The brackets
        are required: PHP keeps only the last value for a repeated plain key, so
        `teams=A&teams=B` silently resolves to B alone. On requests with a JSON
        body you may send `teams` (no brackets) in the body instead.


        **Values that are not valid ObjectIds are silently ignored** — a
        mistyped team ID behaves as if no team was sent. See the [teams section
        of the API conventions guide](/guides/api-conventions#team-scoping).
      style: form
      explode: true
      schema:
        type: array
        items:
          type: string
      example:
        - 64a1b2c3d4e5f6a7b8c9d0ff
  schemas:
    Envelope:
      type: object
      description: The common response envelope shared by all ConveYour endpoints.
      properties:
        status:
          type: string
          enum:
            - ok
            - failed
          description: '`ok` on success, `failed` on error.'
        message:
          type: string
          description: Human-readable description of the result.
        data:
          description: >-
            The response payload — an object or an array depending on the
            endpoint.
  responses:
    Forbidden:
      description: >-
        The token is missing or invalid, or the service account behind it lacks
        the permission this endpoint requires.
      content:
        application/json:
          example:
            status: failed
            message: Lacking necessary permission add_contacts
            data:
              permission: add_contacts
    NotFound:
      description: No record matched the supplied ID.
      content:
        application/json:
          example:
            status: failed
            message: Contact not found
            data: []
  securitySchemes:
    conveyourToken:
      type: apiKey
      in: header
      name: x-conveyour-token
      description: >-
        Your API key token. Contacts endpoints require a **Server-only — Full
        API** key — see [Authentication](/quickstart).

````

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