# Retrieve an export

`GET https://api.lingohub.com/v2/exports/{exportId}`

LingoHub API V2 (Beta) · [Exports](https://developers.lingohub.com/reference/v2/operations/tags/exports.md) · operation `getExport`

Returns one export. Poll it while `status` is `QUEUED` or `PROCESSING`. Once it has `SUCCEEDED`, `download_url` points to the zip for 24 hours; reading the export again gives a fresh URL. An export stops at its first failed file and ends `FAILED`; `PARTIALLY_SUCCEEDED` only happens for git and content-platform pushes where some items failed. Requires stack-level resource view permission.

## Parameters

| Parameter | In | Required | Type | Description |
| --- | --- | --- | --- | --- |
| `exportId` | path | yes | string |  |

## Example request

```sh
curl --request GET \
  --url https://api.lingohub.com/v2/exports/EXPORT_ID \
  --header 'Authorization: Bearer YOUR_API_KEY'
```

## Responses

- `200`: The export.
- `400`: 
- `401`: 
- `403`: 
- `404`: 
- `429`: 
- `500`: 
- `503`: 

## OpenAPI definition

The complete definition of this operation, with every schema it references:

````json
{
  "openapi": "3.1.0",
  "info": {
    "title": "LingoHub API V2 (Beta)",
    "version": "2.0"
  },
  "servers": [
    {
      "url": "https://api.lingohub.com",
      "description": "LingoHub"
    }
  ],
  "tags": [
    {
      "name": "Exports",
      "description": "Export the files of a branch in the background and download them."
    }
  ],
  "paths": {
    "/v2/exports/{exportId}": {
      "get": {
        "tags": [
          "Exports"
        ],
        "summary": "Retrieve an export",
        "description": "Returns one export. Poll it while `status` is `QUEUED` or `PROCESSING`. Once it has `SUCCEEDED`, `download_url` points to the zip for 24 hours; reading the export again gives a fresh URL. An export stops at its first failed file and ends `FAILED`; `PARTIALLY_SUCCEEDED` only happens for git and content-platform pushes where some items failed. Requires stack-level resource view permission.",
        "operationId": "getExport",
        "parameters": [
          {
            "name": "exportId",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "description": "Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a resource export, a valid value would be : reg_0197c8f2-5a6b-7cde-8f12-3456789abcde",
              "pattern": "^reg_[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The export.",
            "headers": {
              "ETag": {
                "$ref": "#/components/headers/ETag"
              },
              "RateLimit": {
                "$ref": "#/components/headers/RateLimit"
              },
              "RateLimit-Policy": {
                "$ref": "#/components/headers/RateLimit-Policy"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Export"
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          },
          "500": {
            "$ref": "#/components/responses/InternalServerError"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    }
  },
  "components": {
    "headers": {
      "ETag": {
        "description": "Opaque strong validator for this representation. Keep its quotation marks and use it as If-Match on a documented conditional write. A replay carries the original ETag, which may now be stale.",
        "schema": {
          "type": "string"
        }
      },
      "RateLimit": {
        "description": "State of the rate-limit policy currently closest to rejection (IETF draft-ietf-httpapi-ratelimit-headers): the quoted policy name with `r` = requests remaining right now and `t` = seconds until the full quota is available again. Example: `\"api-key\";r=42;t=7`. Advisory: absent when the request fails authentication or the limiter state is momentarily unknown.",
        "schema": {
          "type": "string"
        }
      },
      "RateLimit-Policy": {
        "description": "The rate-limit policies applied to the request: each quoted policy name with `q` = sustained request quota per window of `w` seconds. Example: `\"api-key\";q=180;w=60, \"workspace\";q=600;w=60`. Advisory: absent when the request fails authentication or the limiter state is momentarily unknown.",
        "schema": {
          "type": "string"
        }
      },
      "Retry-After": {
        "description": "Seconds to wait before retrying.",
        "schema": {
          "type": "integer",
          "format": "int32"
        }
      }
    },
    "schemas": {
      "Export": {
        "type": "object",
        "description": "An export of the branch's files, or a push of them to an integration.",
        "properties": {
          "object_type": {
            "type": "string",
            "description": "Always `EXPORT`.",
            "enum": [
              "EXPORT"
            ],
            "example": "EXPORT"
          },
          "id": {
            "type": "string",
            "description": "Unique identifier of the export.",
            "example": "reg_0197c8f2-5a6b-7cde-8f12-3456789abcde",
            "minLength": 1,
            "pattern": "^reg_[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"
          },
          "branch_id": {
            "type": [
              "string",
              "null"
            ],
            "description": "Unique identifier of the branch the export was made from; null once the branch is deleted.",
            "example": "prb_0197c8f2-5a6b-7cde-8f12-3456789abcde",
            "pattern": "^prb_[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"
          },
          "language_codes": {
            "type": [
              "array",
              "null"
            ],
            "description": "Languages the export was limited to; null when it includes every language.",
            "example": [
              "de",
              "fr"
            ],
            "items": {
              "type": "string"
            }
          },
          "status": {
            "$ref": "#/components/schemas/ExportStatus",
            "description": "Status of the export.",
            "example": "SUCCEEDED"
          },
          "status_details": {
            "description": "Machine-readable outcome explanation, including failures and explained skips; null when no explanation was recorded or is needed.",
            "oneOf": [
              {
                "$ref": "#/components/schemas/SyncStatusDetails"
              },
              {
                "type": "null"
              }
            ],
            "example": null
          },
          "git_result": {
            "description": "Persisted commit, actual Git head branch and any associated pull-request reference for this export's confirmed successful push; null when no complete result was recorded. A later failed or skipped attempt can retain an earlier confirmed result. A null result does not prove that a failed provider request had no remote side effects.",
            "oneOf": [
              {
                "$ref": "#/components/schemas/ExportGitResult"
              },
              {
                "type": "null"
              }
            ],
            "example": null
          },
          "download_url": {
            "type": [
              "string",
              "null"
            ],
            "description": "URL of the zip with the exported files, valid for 24 hours; reading the export again gives a fresh one. Null unless the export SUCCEEDED.",
            "example": "https://storage.lingohub.com/exports/reg_0197c8f2-5a6b-7cde-8f12-3456789abcde?token=abc"
          },
          "download_url_expires_at": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time",
            "description": "When `download_url` stops working. Retrieve the export again for a fresh URL; null when there is no URL.",
            "example": "2025-01-16T10:30:00.123Z"
          },
          "created_at": {
            "type": "string",
            "format": "date-time",
            "description": "Timestamp when the export was created.",
            "example": "2025-01-15T10:30:00.123Z"
          },
          "updated_at": {
            "type": "string",
            "format": "date-time",
            "description": "Timestamp when the export was last updated.",
            "example": "2025-06-20T14:45:00.123Z"
          }
        },
        "required": [
          "branch_id",
          "created_at",
          "download_url",
          "download_url_expires_at",
          "git_result",
          "id",
          "language_codes",
          "object_type",
          "status",
          "status_details",
          "updated_at"
        ]
      },
      "ExportStatus": {
        "type": "string",
        "description": "Status of an export. `QUEUED` and `PROCESSING` are pending; the others are final. `SUCCEEDED`: every file was exported and the zip can be downloaded. `PARTIALLY_SUCCEEDED`: a git or content-platform push in which some items failed. `FAILED`: a file failed and the export stopped; `status_details` says why. `CANCELLED`: the project was deleted before the export ran. `SKIPPED`: an integration push found nothing to do.",
        "enum": [
          "QUEUED",
          "PROCESSING",
          "SUCCEEDED",
          "PARTIALLY_SUCCEEDED",
          "FAILED",
          "CANCELLED",
          "SKIPPED"
        ]
      },
      "SyncStatusDetails": {
        "type": "object",
        "description": "A machine-readable explanation of a background operation or entry outcome. The detail is safe display text, not a value to parse. A failed or partial operation may already have applied changes; inspect its entries before retrying.",
        "properties": {
          "code": {
            "$ref": "#/components/schemas/SyncStatusCode",
            "description": "Stable public outcome code.",
            "example": "NO_FILES"
          },
          "detail": {
            "type": "string",
            "description": "English explanation of the outcome.",
            "example": "There are no files to export."
          }
        },
        "required": [
          "code",
          "detail"
        ]
      },
      "SyncStatusCode": {
        "type": "string",
        "description": "Public background-operation and entry outcome codes. ALREADY_EXISTS explains a skipped language addition. PARTIAL_FAILURE means some work completed. UNKNOWN_ERROR means no more specific cause was recorded. Clients must tolerate future codes.",
        "enum": [
          "ALREADY_EXISTS",
          "UNKNOWN_ERROR",
          "PARTIAL_FAILURE",
          "STORAGE_UPLOAD_FAILED",
          "STORAGE_DOWNLOAD_FAILED",
          "ARCHIVE_CREATION_FAILED",
          "LANGUAGE_NOT_DETECTED",
          "FILE_PATH_NOT_DETECTED",
          "PRETRANSLATION_FAILED",
          "TRANSLATION_PROVIDER_FAILED",
          "EMPTY_FILE",
          "UNKNOWN_ENCODING",
          "UNSUPPORTED_IMPORT_FORMAT",
          "INVALID_FILE_SYNTAX",
          "DUPLICATE_KEY",
          "KEY_OPERATION_IN_PROGRESS",
          "INVALID_DOCUMENT",
          "DOCUMENT_PROCESSING_FAILED",
          "UNSUPPORTED_EXPORT_FORMAT",
          "FILE_GENERATION_FAILED",
          "INVALID_FILE_STRUCTURE",
          "RESOURCE_TREE_CHANGED",
          "RESOURCE_NOT_FOUND",
          "LANGUAGE_NOT_FOUND",
          "LANGUAGE_NOT_SUPPORTED",
          "NO_RESOURCES",
          "NO_FILES",
          "ENTRY_FAILURES",
          "DOCUMENT_VERSION_MISSING",
          "DOCUMENT_MERGE_FAILED",
          "INVALID_TRANSLATIONS",
          "INTEGRATION_RESOURCE_NOT_FOUND",
          "INTEGRATION_FAILED",
          "INCOMPLETE_TRANSLATION",
          "INTERRUPTED",
          "SELECTION_CHANGED",
          "EMPTY_SELECTION",
          "MOVE_SOURCE_CHANGED",
          "BACKUP_FAILED",
          "RESTORE_FAILED",
          "EXECUTION_FAILED",
          "TIMED_OUT"
        ]
      },
      "ExportGitResult": {
        "type": "object",
        "description": "The persisted result of a confirmed Git push for this export.",
        "properties": {
          "commit_sha": {
            "type": "string",
            "description": "Commit SHA returned by the Git provider for this export's successful push.",
            "example": "0a1b2c3d4e5f0a1b2c3d4e5f0a1b2c3d4e5f0a1b"
          },
          "git_branch": {
            "type": "string",
            "description": "Actual destination Git branch; for a pull-request push this is the normalized head branch, not the base branch.",
            "example": "lingohub/main"
          },
          "pull_request_reference": {
            "type": [
              "string",
              "null"
            ],
            "description": "Repository-local pull-request reference confirmed by the provider for this export. Null for direct pushes, older exports or a confirmed pull request whose provider response lacks a usable reference. This is a provider reference, not a LingoHub entity ID.",
            "example": "42"
          },
          "pull_request_url": {
            "type": [
              "string",
              "null"
            ],
            "description": "Provider-returned web link for the confirmed pull request, or null when unavailable. No URL is inferred from a branch or credential-bearing connection.",
            "example": "https://github.com/example/translations/pull/42"
          }
        },
        "required": [
          "commit_sha",
          "git_branch",
          "pull_request_reference",
          "pull_request_url"
        ]
      },
      "Error": {
        "type": "object",
        "description": "RFC 9457 problem details. `code` identifies the problem type (one per `type` URL); `errors` lists rejected fields or parameters; `required_permission` names the permission a 403 lacked.",
        "properties": {
          "type": {
            "type": "string",
            "description": "URL identifying the problem type and pointing to its documentation.",
            "example": "https://api.lingohub.com/errors/resource-not-found"
          },
          "title": {
            "type": "string",
            "description": "Short, constant summary of the problem type.",
            "example": "Resource not found"
          },
          "status": {
            "type": "integer",
            "format": "int32",
            "description": "HTTP status code.",
            "example": 404
          },
          "detail": {
            "type": "string",
            "description": "Human-readable explanation of this occurrence of the problem.",
            "example": "Resource with ID 'pr_0197c8f2-5a6b-7cde-8f12-3456789abcde' was not found."
          },
          "instance": {
            "type": "string",
            "description": "Path of the request that produced the problem.",
            "example": "/v2/projects/pr_0197c8f2-5a6b-7cde-8f12-3456789abcde"
          },
          "code": {
            "$ref": "#/components/schemas/ErrorCode",
            "description": "Machine-readable problem type.",
            "example": "resource_not_found"
          },
          "request_id": {
            "type": "string",
            "description": "Correlation id of the request, also returned in the `X-Request-ID` header. Quote it when contacting support.",
            "example": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
          },
          "errors": {
            "type": "array",
            "description": "Rejected fields or parameters. Present when the problem concerns specific fields or parameters.",
            "example": [
              {
                "detail": "must be at least 2 characters long",
                "pointer": "#/name",
                "parameter": "limit",
                "code": "minLength"
              }
            ],
            "items": {
              "$ref": "#/components/schemas/FieldError"
            }
          },
          "required_permission": {
            "$ref": "#/components/schemas/RequiredPermission",
            "description": "The permission the API key lacks. Present on 403 responses."
          }
        },
        "required": [
          "code",
          "detail",
          "instance",
          "request_id",
          "status",
          "title",
          "type"
        ]
      },
      "ErrorCode": {
        "type": "string",
        "description": "Machine-readable problem type of a V2 error response. Each code has a fixed HTTP status and documentation at its `type` URL.",
        "enum": [
          "invalid_json",
          "invalid_parameter",
          "missing_parameter",
          "unknown_parameter",
          "invalid_filter",
          "invalid_cursor",
          "bad_request",
          "missing_api_key",
          "invalid_api_key",
          "expired_api_key",
          "revoked_api_key",
          "disabled_api_key",
          "insufficient_permissions",
          "resource_not_found",
          "route_not_found",
          "method_not_allowed",
          "not_acceptable",
          "precondition_failed",
          "content_too_large",
          "unsupported_media_type",
          "already_exists",
          "idempotency_outcome_unknown",
          "idempotency_key_in_use",
          "stack_not_empty",
          "branch_not_ready",
          "backup_not_ready",
          "backup_in_use",
          "default_branch_protected",
          "owner_membership_protected",
          "source_language_protected",
          "branch_limit_reached",
          "context_image_limit_reached",
          "automation_limit_reached",
          "translation_order_pending",
          "git_integration_not_configured",
          "branch_git_integration_not_configured",
          "git_integration_unauthorized",
          "conflict",
          "validation_failed",
          "idempotency_key_mismatch",
          "rate_limit_exceeded",
          "internal_error",
          "upstream_error",
          "service_unavailable",
          "upstream_timeout"
        ]
      },
      "FieldError": {
        "type": "object",
        "description": "A rejected field or parameter. `pointer` locates a body field (RFC 6901 JSON Pointer), `parameter` a query, path or header parameter or a field of a multipart upload; both are set for a position inside a JSON-valued parameter such as `filter`.",
        "properties": {
          "detail": {
            "type": "string",
            "description": "Human-readable description of the problem.",
            "example": "must be at least 2 characters long"
          },
          "pointer": {
            "type": [
              "string",
              "null"
            ],
            "description": "JSON Pointer to the offending body field, or to the position inside a JSON-valued parameter.",
            "example": "#/name"
          },
          "parameter": {
            "type": [
              "string",
              "null"
            ],
            "description": "Name of the offending query, path or header parameter, or of the multipart form field.",
            "example": "limit"
          },
          "code": {
            "$ref": "#/components/schemas/FieldErrorCode",
            "description": "Why the field or parameter was rejected.",
            "example": "minLength"
          }
        },
        "required": [
          "code",
          "detail",
          "parameter",
          "pointer"
        ]
      },
      "FieldErrorCode": {
        "type": "string",
        "description": "Why a field or parameter was rejected: the JSON Schema keyword of the violated rule, or one of the documented rules that no schema can express.",
        "enum": [
          "required",
          "type",
          "enum",
          "minLength",
          "maxLength",
          "minimum",
          "maximum",
          "pattern",
          "format",
          "additionalProperties",
          "minItems",
          "maxItems",
          "uniqueItems",
          "already_exists",
          "not_found",
          "not_supported",
          "unsupported_file_extension",
          "file_too_large",
          "file_empty",
          "invalid_archive",
          "empty_archive"
        ]
      },
      "RequiredPermission": {
        "type": "object",
        "description": "The permission the API key lacks, in the vocabulary of the API key permission settings.",
        "properties": {
          "scope": {
            "$ref": "#/components/schemas/PermissionScope",
            "description": "Where the permission applies.",
            "example": "STACK"
          },
          "target": {
            "$ref": "#/components/schemas/PermissionTarget",
            "description": "The area the permission governs.",
            "example": "SETTINGS"
          },
          "level": {
            "$ref": "#/components/schemas/PermissionLevel",
            "description": "The access level required.",
            "example": "MANAGE"
          }
        },
        "required": [
          "level",
          "scope",
          "target"
        ]
      },
      "PermissionScope": {
        "type": "string",
        "description": "Where a permission applies: `WORKSPACE` permissions cover workspace-level resources, `STACK` permissions the resources of a stack (its projects, branches, resources, languages, ...).",
        "enum": [
          "WORKSPACE",
          "STACK"
        ]
      },
      "PermissionTarget": {
        "type": "string",
        "description": "The area a permission governs.",
        "enum": [
          "GENERAL",
          "BILLING_SUBSCRIPTION",
          "WORKSPACES",
          "MEMBERS",
          "PLUGINS_INTEGRATIONS",
          "LOGS",
          "API_ACCESS",
          "STACKS",
          "TRANSLATION_ORDERS",
          "WORK_REPORTS",
          "STYLE_GUIDES",
          "GLOSSARIES",
          "TRANSLATION_MEMORIES",
          "LABELS",
          "AI_TRANSLATION",
          "QUICK_TRANSLATIONS",
          "SETTINGS",
          "ACTIVITIES",
          "RESOURCES",
          "CONTEXT_IMAGES",
          "LANGUAGES",
          "SEGMENT_KEYS",
          "SEGMENTS",
          "SEGMENT_TEXTS"
        ]
      },
      "PermissionLevel": {
        "type": "string",
        "description": "Access level of a permission: `MANAGE` includes `WRITE` and `VIEW`.",
        "enum": [
          "NO_ACCESS",
          "VIEW",
          "WRITE",
          "MANAGE"
        ]
      }
    },
    "responses": {
      "BadRequest": {
        "description": "The request is malformed: an unknown or invalid query parameter, an invalid id in the path, or a body that is not valid JSON. `code` names the problem, `errors` the parameter or field.",
        "headers": {
          "RateLimit": {
            "$ref": "#/components/headers/RateLimit"
          },
          "RateLimit-Policy": {
            "$ref": "#/components/headers/RateLimit-Policy"
          }
        },
        "content": {
          "application/problem+json": {
            "schema": {
              "$ref": "#/components/schemas/Error"
            }
          }
        }
      },
      "Unauthorized": {
        "description": "Invalid or missing API key.",
        "content": {
          "application/problem+json": {
            "schema": {
              "$ref": "#/components/schemas/Error"
            }
          }
        }
      },
      "Forbidden": {
        "description": "Insufficient permissions.",
        "headers": {
          "RateLimit": {
            "$ref": "#/components/headers/RateLimit"
          },
          "RateLimit-Policy": {
            "$ref": "#/components/headers/RateLimit-Policy"
          }
        },
        "content": {
          "application/problem+json": {
            "schema": {
              "$ref": "#/components/schemas/Error"
            }
          }
        }
      },
      "NotFound": {
        "description": "The resource does not exist, or the API key cannot see it.",
        "headers": {
          "RateLimit": {
            "$ref": "#/components/headers/RateLimit"
          },
          "RateLimit-Policy": {
            "$ref": "#/components/headers/RateLimit-Policy"
          }
        },
        "content": {
          "application/problem+json": {
            "schema": {
              "$ref": "#/components/schemas/Error"
            }
          }
        }
      },
      "TooManyRequests": {
        "description": "The API rate limit was exceeded. Wait for the number of seconds given in the Retry-After header, then retry.",
        "headers": {
          "Retry-After": {
            "$ref": "#/components/headers/Retry-After"
          },
          "RateLimit": {
            "$ref": "#/components/headers/RateLimit"
          },
          "RateLimit-Policy": {
            "$ref": "#/components/headers/RateLimit-Policy"
          }
        },
        "content": {
          "application/problem+json": {
            "schema": {
              "$ref": "#/components/schemas/Error"
            }
          }
        }
      },
      "InternalServerError": {
        "description": "An unexpected internal server error occurred.",
        "headers": {
          "RateLimit": {
            "$ref": "#/components/headers/RateLimit"
          },
          "RateLimit-Policy": {
            "$ref": "#/components/headers/RateLimit-Policy"
          }
        },
        "content": {
          "application/problem+json": {
            "schema": {
              "$ref": "#/components/schemas/Error"
            }
          }
        }
      },
      "ServiceUnavailable": {
        "description": "The service is temporarily unavailable. Retry after the number of seconds in the Retry-After header.",
        "headers": {
          "Retry-After": {
            "$ref": "#/components/headers/Retry-After"
          },
          "RateLimit": {
            "$ref": "#/components/headers/RateLimit"
          },
          "RateLimit-Policy": {
            "$ref": "#/components/headers/RateLimit-Policy"
          }
        },
        "content": {
          "application/problem+json": {
            "schema": {
              "$ref": "#/components/schemas/Error"
            }
          }
        }
      }
    },
    "securitySchemes": {
      "bearerAuth": {
        "type": "http",
        "description": "API key authentication. Create API keys in your LingoHub workspace settings. Keys use the `lh-api_` prefix. Pass the full key as the Bearer token.",
        "scheme": "bearer"
      }
    }
  }
}
````
