API V1 · Projects
Get project resource file status
curl --request GET \ --url https://api.lingohub.com/v1/WORKSPACE_URL/projects/PROJECT_URL/status \ --header 'Authorization: Bearer YOUR_API_KEY'import requests
url = "https://api.lingohub.com/v1/WORKSPACE_URL/projects/PROJECT_URL/status"
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/status';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/status"
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/status") .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/status', [ '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/status")
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/status"), 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 a comprehensive status overview for the specified project, including:
* The resource containers (files) of the project with per-locale segment status counts
* The supported export formats for those resource containers
* The status of repository connections (GitHub, Bitbucket, Azure, GitLab) and whether pushing is possible
This endpoint is particularly useful for understanding the translation completeness of each resource file and for determining whether repository integrations are properly configured.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”WorkspaceUrl
ProjectUrl
Query Parameters
Section titled “Query Parameters”Name of the project branch. If omitted, the project’s default branch is used. Returns 422 if the branch name does not exist in the project.
Responses
Section titled “Responses”Successfully returns the project’s resource files with their translation statuses, supported export formats, and repository connection details.
Complete resource file overview for a project, including file entries, export formats, repository connection status, and project type metadata.
object
The list of resource file containers in the project, each containing locale-specific files.
A resource container representing a logical group of locale-specific files sharing the same base name and path pattern.
object
The unique identifier of the resource container.
The basename of the resource file (without language suffix and extension).
The unique file path pattern for this container, with a locale placeholder.
The list of locale-specific files belonging to this resource container, including per-file translation status.
A resource container per language entry having additional status information
object
Language code that uniquely identifies a locale. Valid examples would be ‘en’, ‘en-GB’, ‘de’, ‘de-DE’ etc. according to ISO 639-1.
object
The list of export formats supported by this project’s resource type.
Names a possible export format. eg. ‘properties.java’, ‘yaml.rails’
object
Eg. ‘properties.java’
Eg. ‘Java Properties’
The list of repository providers (e.g. GitHub, GitLab, Bitbucket) and their connection status for this project.
Defines a repository connection to a repository provider
object
A repository provider name like ‘github’
True if connected to this provider
Whether the project is currently connected to a source code repository.
Whether it is possible to push translations to the connected repository.
The type of push operation available (e.g. direct push or pull request). Null if the project is not connected to a repository.
Whether the project uses a single resource file for all locales (e.g. a single JSON file with all languages).
Timestamp of the last segment content update. Useful for detecting whether translations have changed since a given point in time.
The list of locale codes available in the project.
Examples
iOS project with GitLab connected
ProjectResourceStatus
{ "resourceFiles": [ { "uuid": "rc_18VdrZH7J24I-194872", "basename": "Payment.strings", "filePathWithLocalePlaceholder": "ios/%{locale}.lproj/Payment.strings", "files": [ { "name": "ios/en.lproj/Payment.strings", "languageCode": "en", "mimeType": "text/plain", "statuses": { "NOT_TRANSLATED": 0, "APPROVED": 12, "TRANSLATED": 0, "DRAFT": 0 }, "failingLingochecksCount": 0 } ] } ], "supportedExportFormats": [ { "id": "strings.ios", "name": "iOS Strings" }, { "id": "xml.android.resources", "name": "Android String Resources" } ], "repositoryConnections": [ { "provider": "github", "connected": false }, { "provider": "bitbucket", "connected": false }, { "provider": "azure", "connected": false }, { "provider": "gitlab", "connected": true } ], "repositoryConnected": true, "pushToRepositoryPossible": true, "pushType": "PULL_REQUEST", "oneFileForAllLocales": false}Unauthorized: Authentication credentials are missing or invalid.
object
Example generated
{ "url": "example", "message": "example", "text": "example"}Forbidden: The authenticated user does not have permission to view resources of this project.
object
Example generated
{ "url": "example", "message": "example", "text": "example"}Not Found: The specified workspace or project does not exist.
object
Example generated
{ "url": "example", "message": "example", "text": "example"}Unprocessable Entity: The specified branch name does not exist in the project.
object
Example generated
{ "url": "example", "message": "example", "text": "example"}