Returns one project with your role in it and some statistics.
HTTP
GET /projects/{projectId}Access: Session token, or an API key with the projects:read scope.
Role: Any role in the project.
Path parameters #
| Parameter | Description |
|---|---|
projectId | The id of the project. |
Response 200 #
The project.
JSON
{
...the fields of a project,
"role": "manager",
"stats": { "keys": 318, "languages": 2, "progress": 42, "contributors": 4 }
}Response fields #
| Field | Type | Description |
|---|---|---|
id | string | The id of the project. |
name | string | The name. |
description | string | The description. |
icon | string or null | An emoji. The app shows an abbreviation of the name instead. |
accent | string | A colour such as #7c3aed. |
type | string or null | What the project is translated for: game, mobile, web, ecommerce or other. null when none was given. |
status | string | active or archived. |
sourceLanguage | string | The language code of the source text. |
targetLanguages | list of string | The language codes of every language of the project, whatever its status. |
progress | integer | Percent of keys on the protected branch that are published, across all languages. |
keys | integer | Number of keys on the protected branch. |
members | list of object | Up to 3 people with access, as initials, from and to for an avatar. |
extraMembers | integer | How many more people have access. |
ageMinutes | integer | Minutes since the project last changed. |
role | string | Your role in the project: manager, reviewer or translator. |
stats | object | keys, languages (number of target languages), progress and contributors. |
Errors #
| Status | error | When |
|---|---|---|
| 401 | unauthenticated | The token is missing or not valid. |
| 404 | not_found | The project does not exist in your organisation, you have no access to it, or projectId is not a UUID. |
| 429 | rate_limited | Too many requests, see Rate limiting. |
See Errors for the error format.