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/acme-corp/projects/my-project/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, GitLab, Azure DevOps, AWS CodeCommit) 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

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

An export format the project can be downloaded in. Pass its id as projectType to download a file in this format.

object
id

The id of the format: ios.strings, ios.stringsdict, android.string.resources, properties or standard_json.

string
name

The name of the format.

string
repositoryConnections

Every repository provider (github, bitbucket, gitlab, azure, aws_code_commit) and whether this project is connected to it.

Array<object>

Defines a repository connection to a repository provider

object
provider

The repository provider: github, bitbucket, gitlab, azure or aws_code_commit.

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": "ios.strings",
"name": "IOS Strings"
},
{
"id": "android.string.resources",
"name": "Android XML"
}
],
"repositoryConnections": [
{
"provider": "github",
"connected": false
},
{
"provider": "bitbucket",
"connected": false
},
{
"provider": "gitlab",
"connected": true
},
{
"provider": "azure",
"connected": false
},
{
"provider": "aws_code_commit",
"connected": false
}
],
"repositoryConnected": true,
"pushToRepositoryPossible": true,
"pushType": "PULL_REQUEST",
"oneFileForAllLocales": false
}

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

Example generated

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

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

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"
}
}