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/acme-corp/projects/my-project/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

The URL slug of the workspace. The project links that GET /v1/projects returns contain it: /v1/{workspaceUrl}/projects/{projectUrl}.

Example

acme-corp
projectUrl
required
string

The URL slug of the project within its workspace. The project links that GET /v1/projects returns contain it: /v1/{workspaceUrl}/projects/{projectUrl}.

Example

my-project
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

What started the export, e.g. API_V1 for an export requested through this API or REPOSITORY_PUSH for a repository push.

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
error
object
code
string
description
string
status
string
Allowed values: 100 CONTINUE 101 SWITCHING_PROTOCOLS 102 PROCESSING 103 EARLY_HINTS 200 OK 201 CREATED 202 ACCEPTED 203 NON_AUTHORITATIVE_INFORMATION 204 NO_CONTENT 205 RESET_CONTENT 206 PARTIAL_CONTENT 207 MULTI_STATUS 208 ALREADY_REPORTED 226 IM_USED 300 MULTIPLE_CHOICES 301 MOVED_PERMANENTLY 302 FOUND 303 SEE_OTHER 304 NOT_MODIFIED 307 TEMPORARY_REDIRECT 308 PERMANENT_REDIRECT 400 BAD_REQUEST 401 UNAUTHORIZED 402 PAYMENT_REQUIRED 403 FORBIDDEN 404 NOT_FOUND 405 METHOD_NOT_ALLOWED 406 NOT_ACCEPTABLE 407 PROXY_AUTHENTICATION_REQUIRED 408 REQUEST_TIMEOUT 409 CONFLICT 410 GONE 411 LENGTH_REQUIRED 412 PRECONDITION_FAILED 413 CONTENT_TOO_LARGE 413 PAYLOAD_TOO_LARGE 414 URI_TOO_LONG 415 UNSUPPORTED_MEDIA_TYPE 416 REQUESTED_RANGE_NOT_SATISFIABLE 417 EXPECTATION_FAILED 418 I_AM_A_TEAPOT 421 MISDIRECTED_REQUEST 422 UNPROCESSABLE_CONTENT 422 UNPROCESSABLE_ENTITY 423 LOCKED 424 FAILED_DEPENDENCY 425 TOO_EARLY 426 UPGRADE_REQUIRED 428 PRECONDITION_REQUIRED 429 TOO_MANY_REQUESTS 431 REQUEST_HEADER_FIELDS_TOO_LARGE 451 UNAVAILABLE_FOR_LEGAL_REASONS 500 INTERNAL_SERVER_ERROR 501 NOT_IMPLEMENTED 502 BAD_GATEWAY 503 SERVICE_UNAVAILABLE 504 GATEWAY_TIMEOUT 505 HTTP_VERSION_NOT_SUPPORTED 506 VARIANT_ALSO_NEGOTIATES 507 INSUFFICIENT_STORAGE 508 LOOP_DETECTED 509 BANDWIDTH_LIMIT_EXCEEDED 510 NOT_EXTENDED 511 NETWORK_AUTHENTICATION_REQUIRED
validationErrors
Array<object>
object
field
string
errors
Array<object>
object
code
string
description
string
parameters
object
key
additional properties

Example

{
"error": {
"status": "100 CONTINUE"
}
}

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
message
required
string | null
items
required
Array<string> | null

Example generated

{
"message": "example",
"items": [
"example"
]
}