API V1 · Exports
Get resource export status
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'import requests
url = "https://api.lingohub.com/v1/WORKSPACE_URL/projects/PROJECT_URL/exports/reg_3163-0556-1428-5087674"
headers = {"Authorization": "Bearer YOUR_API_KEY"}
response = requests.get(url, headers=headers)
print(response.json())const url = 'https://api.lingohub.com/v1/WORKSPACE_URL/projects/PROJECT_URL/exports/reg_3163-0556-1428-5087674';const options = {method: 'GET', headers: {Authorization: 'Bearer YOUR_API_KEY'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}package main
import ( "fmt" "net/http" "io")
func main() {
url := "https://api.lingohub.com/v1/WORKSPACE_URL/projects/PROJECT_URL/exports/reg_3163-0556-1428-5087674"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer YOUR_API_KEY")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close() body, _ := io.ReadAll(res.Body)
fmt.Println(res) fmt.Println(string(body))
}OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder() .url("https://api.lingohub.com/v1/WORKSPACE_URL/projects/PROJECT_URL/exports/reg_3163-0556-1428-5087674") .get() .addHeader("Authorization", "Bearer YOUR_API_KEY") .build();
Response response = client.newCall(request).execute();<?php
$client = new \GuzzleHttp\Client();
$response = $client->request('GET', 'https://api.lingohub.com/v1/WORKSPACE_URL/projects/PROJECT_URL/exports/reg_3163-0556-1428-5087674', [ 'headers' => [ 'Authorization' => 'Bearer YOUR_API_KEY', ],]);
echo $response->getBody();require 'uri'require 'net/http'
url = URI("https://api.lingohub.com/v1/WORKSPACE_URL/projects/PROJECT_URL/exports/reg_3163-0556-1428-5087674")
http = Net::HTTP.new(url.host, url.port)http.use_ssl = true
request = Net::HTTP::Get.new(url)request["Authorization"] = 'Bearer YOUR_API_KEY'
response = http.request(request)puts response.read_bodyusing System.Net.Http.Headers;var client = new HttpClient();var request = new HttpRequestMessage{ Method = HttpMethod.Get, RequestUri = new Uri("https://api.lingohub.com/v1/WORKSPACE_URL/projects/PROJECT_URL/exports/reg_3163-0556-1428-5087674"), Headers = { { "Authorization", "Bearer YOUR_API_KEY" }, },};using (var response = await client.SendAsync(request)){ response.EnsureSuccessStatusCode(); var body = await response.Content.ReadAsStringAsync(); Console.WriteLine(body);}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.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”WorkspaceUrl
ProjectUrl
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
The id of an existing resource export
Example
reg_3163-0556-1428-5087674Responses
Section titled “Responses”Successfully returns the resource export with its current status and download information.
Response containing the status and details of a resource export, including individual file entries and download URLs.
object
The unique identifier for this resource export.
The compound status of this resource export. Reflects the overall progress across all entries.
The list of individual resource export entries (one per file/locale combination).
Status and download information for a single file within a resource export.
object
The file path of the exported entry, including locale placeholder if applicable.
The ISO-639-1 language code for this entry.
The processing status of this individual export entry.
The S3 download URL for this individual file. Null while processing or if an error occurred.
Detailed information about the error that occurred, if the export failed. Null on success.
The name of the ZIP file that is or will be generated for this export.
The S3 download URL for the exported ZIP. Null while the export is in progress or if an error occurred.
The trigger that caused this resource export (e.g. manual, webhook).
Timestamp when the resource export was created.
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"}Export still in progress
ExportProcessing
{ "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"}Unauthorized: Authentication credentials are missing or invalid.
object
Example generated
{ "url": "example", "message": "example", "text": "example"}Forbidden: The authenticated user does not have resource view permission on this project.
object
Example generated
{ "url": "example", "message": "example", "text": "example"}Not Found: The specified export ID, workspace, or project does not exist.
object
Example generated
{ "url": "example", "message": "example", "text": "example"}