Manual
CLI
API
Log in Get started free

List projects

Lists the projects you have access to, the oldest first. Organisation owners and admins see all of them.

Lists the projects you have access to, the oldest first. Organisation owners and admins see all of them.

HTTP
GET /projects

Access: Session token, or an API key with the projects:read scope.

Response 200 #

A list of projects.

JSON
[
{
  "id": "0197a3c6-4d53-7a44-87fb-9b3e5c0a2d64",
  "name": "Shop",
  "description": "The web shop",
  "icon": null,
  "accent": "#7c3aed",
  "type": "web",
  "status": "active",
  "sourceLanguage": "en-gb",
  "targetLanguages": ["de-de", "fr-fr"],
  "progress": 42,
  "keys": 318,
  "members": [{ "initials": "AL", "from": "#06b6d4", "to": "#7c3aed" }],
  "extraMembers": 0,
  "ageMinutes": 15
}
]

Response fields #

FieldTypeDescription
idstringThe id of the project.
namestringThe name.
descriptionstringThe description.
iconstring or nullAn emoji. The app shows an abbreviation of the name instead.
accentstringA colour such as #7c3aed.
typestring or nullWhat the project is translated for: game, mobile, web, ecommerce or other. null when none was given.
statusstringactive or archived.
sourceLanguagestringThe language code of the source text.
targetLanguageslist of stringThe language codes of every language of the project, whatever its status.
progressintegerPercent of keys on the protected branch that are published, across all languages.
keysintegerNumber of keys on the protected branch.
memberslist of objectUp to 3 people with access, as initials, from and to for an avatar.
extraMembersintegerHow many more people have access.
ageMinutesintegerMinutes since the project last changed.

Errors #

StatuserrorWhen
401unauthenticatedThe token is missing or not valid.
429rate_limitedToo many requests, see Rate limiting.

See Errors for the error format.