For Project Managers

For Translators

For Developers

API v1
API v2
Languages
Webhooks

Company

Translation Export Status

Please consider that API 2.0 is now the preferred version to be used. The old API will remain fully functional until the end of 2021.

Crowdin API v2

Get the status of translations export.

Request

Note: Use the combination of project identifier, username, and account key to pass to this endpoint.

GET https://api.crowdin.com/api/project/{project-identifier}/export-status?login={username}&account-key={account-key}

Parameters

Name Value Description
branch optional string The name of related version branch (Versions Management).
json optional string May not contain value. Defines that response should be in JSON format.
jsonp optional string Callback function name. Defines that response should be in JSONP format.
Variables
project-identifier string Project identifier.
login string Your username in Crowdin.
account-key string Your account API key.

Response

Successful

The successful response status can be one of none, in-progress or finished.

If the export is finished, the method returns the following XML structure:

<?xml version="1.0" encoding="UTF-8"?>
<success>
  <status>finished</status>
  <progress>100</progress>
  <last_build>2018-10-22T13:49:00+0000</last_build>
</success>
If the export is in progress, the method returns the following XML structure: 
<?xml version="1.0" encoding="UTF-8"?>
<success>
  <status>in-progress</status>
  <progress>29</progress>
  <last_build>2018-10-18T16:08:00+0000</last_build>
  <current_file>example.xml</current_file>
  <current_language>Ukrainian</current_language>
</success>
If the export has never been built, the method returns the following XML structure: 
<?xml version="1.0" encoding="UTF-8"?>
<success>
  <status>none</status>
  <progress>0</progress>
  <last_build>never</last_build>
</success>

Unsuccessful

<?xml version="1.0" encoding="UTF-8"?>
<error>
  <code>3</code>
  <message>API key is not valid</message>
</error>

Examples

curl \
https://api.crowdin.com/api/project/{project-identifier}/export-status?login={username}&account-key={account-key}
<?php
$request_url = 'https://api.crowdin.com/api/project/{project-identifier}/export-status?login={username}&account-key={account-key}';

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $request_url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

$result = curl_exec($ch);
curl_close($ch);

echo $result;

Was this article helpful?