# Get resource export status

`GET https://api.lingohub.com/v1/{workspaceUrl}/projects/{projectUrl}/exports/{id}`

LingoHub API V1 · [Exports](https://developers.lingohub.com/reference/v1/operations/tags/exports.md) · operation `v1ResourceExportsGetResourceExport`

Retrieves the current status and details of a previously requested resource export. Poll this endpoint to check whether an asynchronous export has completed. Once the status is SUCCESS, the downloadUrl field contains a pre-signed S3 URL for downloading the export. Individual file entries and their statuses are also included.

## Parameters

| Parameter | In | Required | Type | Description |
| --- | --- | --- | --- | --- |
| `workspaceUrl` | path | yes | string | workspaceUrl |
| `projectUrl` | path | yes | string | projectUrl |
| `id` | path | yes | string | the id of an existing resource export |

## Example request

```sh
curl --request GET \
  --url https://api.lingohub.com/v1/WORKSPACE_URL/projects/PROJECT_URL/exports/reg_3163-0556-1428-5087674 \
  --header 'Authorization: Bearer YOUR_API_KEY'
```

## Responses

- `200`: Successfully returns the resource export with its current status and download information.
- `401`: Unauthorized: Authentication credentials are missing or invalid.
- `403`: Forbidden: The authenticated user does not have resource view permission on this project.
- `404`: Not Found: The specified export ID, workspace, or project does not exist.

## OpenAPI definition

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

````json
{
  "openapi": "3.1.0",
  "info": {
    "title": "LingoHub API V1",
    "version": "1"
  },
  "servers": [
    {
      "url": "https://api.lingohub.com",
      "description": "Generated server url"
    }
  ],
  "tags": [
    {
      "name": "Exports",
      "description": "Endpoints for requesting a resource export and checking their statuses"
    }
  ],
  "paths": {
    "/v1/{workspaceUrl}/projects/{projectUrl}/exports/{id}": {
      "get": {
        "tags": [
          "Exports"
        ],
        "summary": "Get resource export status",
        "description": "Retrieves the current status and details of a previously requested resource export. Poll this endpoint to check whether an asynchronous export has completed. Once the status is SUCCESS, the downloadUrl field contains a pre-signed S3 URL for downloading the export. Individual file entries and their statuses are also included.",
        "operationId": "v1ResourceExportsGetResourceExport",
        "parameters": [
          {
            "name": "workspaceUrl",
            "in": "path",
            "description": "workspaceUrl",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "projectUrl",
            "in": "path",
            "description": "projectUrl",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "id",
            "in": "path",
            "description": "the id of an existing resource export",
            "required": true,
            "schema": {
              "type": "string",
              "description": "Specific Id that is created from the id and the 'type' of the corresponding resource. When used in requests, its value is the prefix of the FriendlyIdType followed by the encrypted id of the resource. I.e : For resource_exports, a valid request param value would be : reg_18USq6822XIv-19847171"
            },
            "example": "reg_3163-0556-1428-5087674"
          }
        ],
        "responses": {
          "200": {
            "description": "Successfully returns the resource export with its current status and download information.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ResourceExportResponse"
                },
                "examples": {
                  "exportSuccess": {
                    "summary": "Completed export with download URL",
                    "description": "exportSuccess",
                    "value": {
                      "id": "reg_3163-0556-1428-5087674",
                      "status": "SUCCESS",
                      "resourceExports": [
                        {
                          "filePath": "config/locales/en/messages.yml",
                          "iso2Slug": "en",
                          "status": "SUCCESS",
                          "downloadUrl": "https://lingohub-...s3.amazonaws.com/..."
                        },
                        {
                          "filePath": "config/locales/de/messages.yml",
                          "iso2Slug": "de",
                          "status": "SUCCESS",
                          "downloadUrl": "https://lingohub-...s3.amazonaws.com/..."
                        }
                      ],
                      "errorDetails": null,
                      "filePath": "files.zip",
                      "downloadUrl": "https://lingohub-...s3.amazonaws.com/...",
                      "triggerType": "API_V1",
                      "createdAt": "2025-01-15T10:30:00.000+00:00"
                    }
                  },
                  "exportProcessing": {
                    "summary": "Export still in progress",
                    "description": "exportProcessing",
                    "value": {
                      "id": "reg_3163-0556-1428-5087674",
                      "status": "PROCESSING",
                      "resourceExports": [],
                      "errorDetails": null,
                      "filePath": null,
                      "downloadUrl": null,
                      "triggerType": "API_V1",
                      "createdAt": "2025-01-15T10:30:00.000+00:00"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized: Authentication credentials are missing or invalid.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/V1ErrorInfo"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden: The authenticated user does not have resource view permission on this project.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/V1ErrorInfo"
                }
              }
            }
          },
          "404": {
            "description": "Not Found: The specified export ID, workspace, or project does not exist.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/V1ErrorInfo"
                }
              }
            }
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    }
  },
  "components": {
    "schemas": {
      "ResourceExportResponse": {
        "type": "object",
        "description": "Response containing the status and details of a resource export, including individual file entries and download URLs.",
        "properties": {
          "id": {
            "type": "string",
            "description": "The unique identifier for this resource export.",
            "example": "reg_abc123def456"
          },
          "status": {
            "$ref": "#/components/schemas/ResourceExportParamStatus",
            "description": "The compound status of this resource export. Reflects the overall progress across all entries."
          },
          "resourceExports": {
            "type": "array",
            "description": "The list of individual resource export entries (one per file/locale combination).",
            "items": {
              "$ref": "#/components/schemas/ResourceExportEntryResponse"
            }
          },
          "errorDetails": {
            "type": "string",
            "description": "Detailed information about the error that occurred, if the export failed. Null on success."
          },
          "filePath": {
            "type": "string",
            "description": "The name of the ZIP file that is or will be generated for this export.",
            "example": "frontend-app.zip"
          },
          "downloadUrl": {
            "type": "string",
            "description": "The S3 download URL for the exported ZIP. Null while the export is in progress or if an error occurred.",
            "example": "https://lingohub-exports.s3.amazonaws.com/exports/abc123/frontend-app.zip"
          },
          "triggerType": {
            "$ref": "#/components/schemas/TriggerType",
            "description": "The trigger that caused this resource export (e.g. manual, webhook)."
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "description": "Timestamp when the resource export was created.",
            "example": "2025-02-20T14:45:00.000+00:00"
          }
        },
        "required": [
          "id",
          "resourceExports",
          "status"
        ]
      },
      "ResourceExportParamStatus": {
        "type": "string",
        "enum": [
          "NEW",
          "SCHEDULED",
          "PROCESSING",
          "SUCCESS",
          "SKIPPED",
          "ERROR"
        ]
      },
      "ResourceExportEntryResponse": {
        "type": "object",
        "description": "Status and download information for a single file within a resource export.",
        "properties": {
          "filePath": {
            "type": "string",
            "description": "The file path of the exported entry, including locale placeholder if applicable.",
            "example": "config/locales/en/messages.yml"
          },
          "iso2Slug": {
            "type": "string",
            "description": "The ISO-639-1 language code for this entry.",
            "example": "de-AT"
          },
          "status": {
            "$ref": "#/components/schemas/ResourceExportParamStatus",
            "description": "The processing status of this individual export entry."
          },
          "downloadUrl": {
            "type": "string",
            "description": "The S3 download URL for this individual file. Null while processing or if an error occurred.",
            "example": "https://lingohub-exports.s3.amazonaws.com/exports/abc123/messages_de-AT.yml"
          }
        }
      },
      "TriggerType": {
        "type": "string",
        "enum": [
          "DOWNLOAD_SINGLE",
          "DOWNLOAD_MULTIPLE",
          "REPOSITORY_PUSH_MULTIPLE",
          "REPOSITORY_PUSH",
          "DISTRIBUTION_RELEASE",
          "PACKAGES",
          "BACKUPS",
          "ZENDESK_SELECTED",
          "ZENDESK_ALL",
          "ZENDESK_PUSH",
          "API_V1",
          "API_V2",
          "SINGLE_FILE_API_V1",
          "SEGMENT_CONTAINER",
          "XLIFF",
          "STORYBLOK_PUSH",
          "CONTENTFUL_PUSH",
          "CSV",
          "HUBSPOT_PUSH",
          "STRIPO_PUSH",
          "CRISP_HELPDESK_PUSH"
        ]
      },
      "V1ErrorInfo": {
        "type": "object",
        "properties": {
          "url": {
            "type": "string"
          },
          "message": {
            "type": "string"
          },
          "text": {
            "type": "string"
          }
        }
      }
    },
    "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"
      }
    }
  }
}
````
