Skip to content

API V1 · Projects

Get project resource file status

GET
/v1/{workspaceUrl}/projects/{projectUrl}/status
curl --request GET \
--url https://api.lingohub.com/v1/WORKSPACE_URL/projects/PROJECT_URL/status \
--header 'Authorization: Bearer YOUR_API_KEY'
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.
workspaceUrl
required
string

WorkspaceUrl

projectUrl
required
string

ProjectUrl

branch
string

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.

Successfully returns the project’s resource files with their translation statuses, supported export formats, and repository connection details.

Media typeapplication/json

Complete resource file overview for a project, including file entries, export formats, repository connection status, and project type metadata.

object
resourceFiles

The list of resource file containers in the project, each containing locale-specific files.

Array<object>

A resource container representing a logical group of locale-specific files sharing the same base name and path pattern.

object
uuid

The unique identifier of the resource container.

string
basename

The basename of the resource file (without language suffix and extension).

string
filePathWithLocalePlaceholder

The unique file path pattern for this container, with a locale placeholder.

string
files

The list of locale-specific files belonging to this resource container, including per-file translation status.

Array<object>

A resource container per language entry having additional status information

object
name
string
languageCode

Language code that uniquely identifies a locale. Valid examples would be ‘en’, ‘en-GB’, ‘de’, ‘de-DE’ etc. according to ISO 639-1.

string
mimeType
string
statuses
object
key
additional properties
integer format: int32
segmentsUpdatedAt
string format: date-time
failingLingochecksCount
integer format: int32
supportedExportFormats

The list of export formats supported by this project’s resource type.

Array<object>

Names a possible export format. eg. ‘properties.java’, ‘yaml.rails’

object
id

Eg. ‘properties.java’

string
name

Eg. ‘Java Properties’

string
repositoryConnections

The list of repository providers (e.g. GitHub, GitLab, Bitbucket) and their connection status for this project.

Array<object>

Defines a repository connection to a repository provider

object
provider

A repository provider name like ‘github’

string
connected

True if connected to this provider

boolean
repositoryConnected

Whether the project is currently connected to a source code repository.

boolean
pushToRepositoryPossible

Whether it is possible to push translations to the connected repository.

boolean
pushType

The type of push operation available (e.g. direct push or pull request). Null if the project is not connected to a repository.

string
Allowed values: PUSH PULL_REQUEST
oneFileForAllLocales

Whether the project uses a single resource file for all locales (e.g. a single JSON file with all languages).

boolean
segmentsUpdatedAt

Timestamp of the last segment content update. Useful for detecting whether translations have changed since a given point in time.

string format: date-time
availableLocales

The list of locale codes available in the project.

Array<string>

Examples

ExampleprojectResourceStatus

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.

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 permission to view resources of this project.

Media typeapplication/json
object
url
string
message
string
text
string

Example generated

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

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

Media typeapplication/json
object
url
string
message
string
text
string

Example generated

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

Unprocessable Entity: The specified branch name does not exist in the project.

Media typeapplication/json
object
url
string
message
string
text
string

Example generated

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