# Get project resource file status

`GET https://api.lingohub.com/v1/{workspaceUrl}/projects/{projectUrl}/status`

LingoHub API V1 · [Projects](https://developers.lingohub.com/reference/v1/operations/tags/projects.md) · operation `v1ProjectGetProjectStatus`

    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.


## Parameters

| Parameter | In | Required | Type | Description |
| --- | --- | --- | --- | --- |
| `workspaceUrl` | path | yes | string | workspaceUrl |
| `projectUrl` | path | yes | string | projectUrl |
| `branch` | query | no | 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. |

## Example request

```sh
curl --request GET \
  --url https://api.lingohub.com/v1/WORKSPACE_URL/projects/PROJECT_URL/status \
  --header 'Authorization: Bearer YOUR_API_KEY'
```

## Responses

- `200`: Successfully returns the project's resource files with their translation statuses, supported export formats, and repository connection details.
- `401`: Unauthorized: Authentication credentials are missing or invalid.
- `403`: Forbidden: The authenticated user does not have permission to view resources of this project.
- `404`: Not Found: The specified workspace or project does not exist.
- `422`: Unprocessable Entity: The specified branch name does not exist in the project.

## OpenAPI definition

The complete definition of this operation, with every schema it references:

````json
{
  "openapi": "3.1.0",
  "info": {
    "title": "LingoHub API V1",
    "version": "1"
  },
  "servers": [
    {
      "url": "https://api.lingohub.com",
      "description": "Generated server url"
    }
  ],
  "tags": [
    {
      "name": "Projects",
      "description": "Endpoints for the operations that can be performed on projects of a workspace"
    }
  ],
  "paths": {
    "/v1/{workspaceUrl}/projects/{projectUrl}/status": {
      "get": {
        "tags": [
          "Projects"
        ],
        "summary": "Get project resource file status",
        "description": "    Retrieves a comprehensive status overview for the specified project, including:\n\n     * The resource containers (files) of the project with per-locale segment status counts\n     * The supported export formats for those resource containers\n     * The status of repository connections (GitHub, Bitbucket, Azure, GitLab) and whether pushing is possible\n\n    This endpoint is particularly useful for understanding the translation completeness of each resource file     and for determining whether repository integrations are properly configured.\n",
        "operationId": "v1ProjectGetProjectStatus",
        "parameters": [
          {
            "name": "workspaceUrl",
            "in": "path",
            "description": "workspaceUrl",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "projectUrl",
            "in": "path",
            "description": "projectUrl",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "branch",
            "in": "query",
            "description": "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.",
            "required": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successfully returns the project's resource files with their translation statuses, supported export formats, and repository connection details.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProjectResourceFiles"
                },
                "examples": {
                  "projectResourceStatus": {
                    "summary": "iOS project with GitLab connected",
                    "description": "projectResourceStatus",
                    "value": {
                      "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
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized: Authentication credentials are missing or invalid.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/V1ErrorInfo"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden: The authenticated user does not have permission to view resources of this project.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/V1ErrorInfo"
                }
              }
            }
          },
          "404": {
            "description": "Not Found: The specified workspace or project does not exist.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/V1ErrorInfo"
                }
              }
            }
          },
          "422": {
            "description": "Unprocessable Entity: The specified branch name does not exist in the project.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/V1ErrorInfo"
                }
              }
            }
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    }
  },
  "components": {
    "schemas": {
      "ProjectResourceFiles": {
        "type": "object",
        "description": "Complete resource file overview for a project, including file entries, export formats, repository connection status, and project type metadata.",
        "properties": {
          "resourceFiles": {
            "type": "array",
            "description": "The list of resource file containers in the project, each containing locale-specific files.",
            "items": {
              "$ref": "#/components/schemas/V1ResourceFileEntry"
            }
          },
          "supportedExportFormats": {
            "type": "array",
            "description": "The list of export formats supported by this project's resource type.",
            "items": {
              "$ref": "#/components/schemas/V1ExportFormat"
            }
          },
          "repositoryConnections": {
            "type": "array",
            "description": "The list of repository providers (e.g. GitHub, GitLab, Bitbucket) and their connection status for this project.",
            "items": {
              "$ref": "#/components/schemas/RepositoryConnectionStatus"
            }
          },
          "repositoryConnected": {
            "type": "boolean",
            "description": "Whether the project is currently connected to a source code repository."
          },
          "pushToRepositoryPossible": {
            "type": "boolean",
            "description": "Whether it is possible to push translations to the connected repository."
          },
          "pushType": {
            "$ref": "#/components/schemas/PushType",
            "description": "The type of push operation available (e.g. direct push or pull request). Null if the project is not connected to a repository."
          },
          "oneFileForAllLocales": {
            "type": "boolean",
            "description": "Whether the project uses a single resource file for all locales (e.g. a single JSON file with all languages)."
          },
          "segmentsUpdatedAt": {
            "type": "string",
            "format": "date-time",
            "description": "Timestamp of the last segment content update. Useful for detecting whether translations have changed since a given point in time.",
            "example": "2025-02-20T14:45:00"
          },
          "availableLocales": {
            "type": "array",
            "description": "The list of locale codes available in the project.",
            "example": [
              "en",
              "de",
              "fr"
            ],
            "items": {
              "type": "string",
              "description": "Language code that uniquely identifies a locale. Valid examples would be 'en', 'en-GB', 'de', 'de-DE' etc. according to [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes)."
            }
          }
        }
      },
      "V1ResourceFileEntry": {
        "type": "object",
        "description": "A resource container representing a logical group of locale-specific files sharing the same base name and path pattern.",
        "properties": {
          "uuid": {
            "type": "string",
            "description": "The unique identifier of the resource container.",
            "example": "rc_1234567890abcdef"
          },
          "basename": {
            "type": "string",
            "description": "The basename of the resource file (without language suffix and extension).",
            "example": "messages"
          },
          "filePathWithLocalePlaceholder": {
            "type": "string",
            "description": "The unique file path pattern for this container, with a locale placeholder.",
            "example": "config/locales/%{locale}/messages.yml"
          },
          "files": {
            "type": "array",
            "description": "The list of locale-specific files belonging to this resource container, including per-file translation status.",
            "items": {
              "$ref": "#/components/schemas/ResourceFileLocaleEntry"
            }
          }
        }
      },
      "ResourceFileLocaleEntry": {
        "type": "object",
        "description": "A resource container per language entry having additional status information",
        "properties": {
          "name": {
            "type": "string"
          },
          "languageCode": {
            "type": "string",
            "description": "Language code that uniquely identifies a locale. Valid examples would be 'en', 'en-GB', 'de', 'de-DE' etc. according to [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes)."
          },
          "mimeType": {
            "type": "string"
          },
          "statuses": {
            "type": "object",
            "additionalProperties": {
              "type": "integer",
              "format": "int32"
            }
          },
          "segmentsUpdatedAt": {
            "type": "string",
            "format": "date-time"
          },
          "failingLingochecksCount": {
            "type": "integer",
            "format": "int32"
          }
        }
      },
      "V1ExportFormat": {
        "type": "object",
        "description": "Names a possible export format. eg. 'properties.java', 'yaml.rails'",
        "properties": {
          "id": {
            "type": "string",
            "description": "eg. 'properties.java'"
          },
          "name": {
            "type": "string",
            "description": "eg. 'Java Properties'"
          }
        }
      },
      "RepositoryConnectionStatus": {
        "type": "object",
        "description": "Defines a repository connection to a repository provider",
        "properties": {
          "provider": {
            "type": "string",
            "description": "A repository provider name like 'github'"
          },
          "connected": {
            "type": "boolean",
            "description": "true if connected to this provider"
          }
        }
      },
      "PushType": {
        "type": "string",
        "enum": [
          "PUSH",
          "PULL_REQUEST"
        ]
      },
      "V1ErrorInfo": {
        "type": "object",
        "properties": {
          "url": {
            "type": "string"
          },
          "message": {
            "type": "string"
          },
          "text": {
            "type": "string"
          }
        }
      }
    },
    "securitySchemes": {
      "bearerAuth": {
        "type": "http",
        "description": "API key authentication. Create API keys in your LingoHub workspace settings. Keys use the `lh-api_` prefix. Pass the full key as the Bearer token.",
        "scheme": "bearer"
      }
    }
  }
}
````
