Skip to content

API V1 · Exports

Get resource export status

GET
/v1/{workspaceUrl}/projects/{projectUrl}/exports/{id}
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'

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.

workspaceUrl
required
string

WorkspaceUrl

projectUrl
required
string

ProjectUrl

id
required

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

string

The id of an existing resource export

Example

reg_3163-0556-1428-5087674

Successfully returns the resource export with its current status and download information.

Media typeapplication/json

Response containing the status and details of a resource export, including individual file entries and download URLs.

object
id
required

The unique identifier for this resource export.

string
status
required

The compound status of this resource export. Reflects the overall progress across all entries.

string
Allowed values: NEW SCHEDULED PROCESSING SUCCESS SKIPPED ERROR
resourceExports
required

The list of individual resource export entries (one per file/locale combination).

Array<object>

Status and download information for a single file within a resource export.

object
filePath

The file path of the exported entry, including locale placeholder if applicable.

string
iso2Slug

The ISO-639-1 language code for this entry.

string
status

The processing status of this individual export entry.

string
Allowed values: NEW SCHEDULED PROCESSING SUCCESS SKIPPED ERROR
downloadUrl

The S3 download URL for this individual file. Null while processing or if an error occurred.

string
errorDetails

Detailed information about the error that occurred, if the export failed. Null on success.

string
filePath

The name of the ZIP file that is or will be generated for this export.

string
downloadUrl

The S3 download URL for the exported ZIP. Null while the export is in progress or if an error occurred.

string
triggerType

The trigger that caused this resource export (e.g. manual, webhook).

string
Allowed values: 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
createdAt

Timestamp when the resource export was created.

string format: date-time

Examples

Completed export with download URL

ExportSuccess

{
"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"
}

Unauthorized: Authentication credentials are missing or invalid.

Media typeapplication/json
object
url
string
message
string
text
string

Example generated

{
"url": "example",
"message": "example",
"text": "example"
}

Forbidden: The authenticated user does not have resource view permission on this project.

Media typeapplication/json
object
url
string
message
string
text
string

Example generated

{
"url": "example",
"message": "example",
"text": "example"
}

Not Found: The specified export ID, workspace, or project does not exist.

Media typeapplication/json
object
url
string
message
string
text
string

Example generated

{
"url": "example",
"message": "example",
"text": "example"
}