Returns the workflow flags, file format and message format of a project.
HTTP
GET /projects/{projectId}/settingsAccess: Session token only. API keys get 403 with insufficient_scope.
Role: Any role in the project.
Path parameters #
| Parameter | Description |
|---|---|
projectId | The id of the project. |
Response 200 #
The settings.
JSON
{
"flags": {
"requireReview": true,
"selfReview": false,
"notifyReviewers": true,
"mtSuggestions": true,
"mtAutofill": false,
"mtFlag": true,
"freeze": false,
"importCreate": true,
"importOverwrite": false,
"importReview": true,
"gitTags": false
},
"format": "json",
"messageFormat": "ICU (recommended)",
"mtProvider": null,
"mtConnected": ["deepl"],
"machineTranslation": { "providers": ["deepl"], "default": "deepl" }
}Response fields #
| Field | Type | Description |
|---|---|---|
flags.requireReview | boolean | Translations must be approved before they are published. |
flags.selfReview | boolean | Reviewers may approve their own translations. |
flags.notifyReviewers | boolean | Email reviewers when a translation is submitted. |
flags.mtSuggestions | boolean | Machine translation suggestions. |
flags.mtAutofill | boolean | Translate new strings automatically after a push, see mtProvider. |
flags.mtFlag | boolean | Flag machine translated text. |
flags.freeze | boolean | Freeze the project: push and key changes are refused. |
flags.importCreate | boolean | Imports may create keys. |
flags.importOverwrite | boolean | Imports may overwrite existing translations. |
flags.importReview | boolean | Imported translations go to review. |
flags.gitTags | boolean | A tag pushed to the linked GitHub or GitLab repository makes a tag of main with the same name. |
format | string | json, yaml, po or xliff. |
messageFormat | string | ICU (recommended), i18next, Fluent or None. |
mtProvider | string|null | The service that translates automatically for this project, one of the services in Machine translation. null means the organisation’s default. |
mtConnected | string[] | The services the organisation set up and that have not refused their key, the default first, whether or not flags.mtSuggestions is on. These are the ones mtProvider can use. |
machineTranslation.providers | string[] | The machine translation services the organisation set up and that have not refused their key, the default first. Empty when none, and also when flags.mtSuggestions is off. The editor only shows the suggestion panel when it is not empty. |
machineTranslation.default | string|null | The service a suggestion uses when none is asked for. |
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.