Version 1
Connector Overview: This page documents all 275 actions for the Phrasestringsconnector v1.
Accounts (2)
GET Get a single account
/accounts/{id}
Get details on a single account.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
ID |
|
|
N/A |
GET List accounts
/accounts
List all accounts the current user has access to.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Page number |
|
|
Limit on the number of objects to be returned, between 1 and 100. 25 by default |
|
|
N/A |
Authorizations (5)
POST Create an authorization
/authorizations
Create a new authorization.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
A note to help you remember what the access is used for. |
|
|
A list of scopes that the access can be used for. |
|
|
Expiration date for the authorization token. Null means no expiration date (default). |
DELETE Delete an authorization
/authorizations/{id}
Delete an existing authorization. API calls using that token will stop working.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
ID |
|
|
N/A |
GET Get a single authorization
/authorizations/{id}
Get details on a single authorization.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
ID |
|
|
N/A |
GET List authorizations
/authorizations
List all your authorizations.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Page number |
|
|
Limit on the number of objects to be returned, between 1 and 100. 25 by default |
|
|
N/A |
PATCH Update an authorization
/authorizations/{id}
Update an existing authorization.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
ID |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
A note to help you remember what the access is used for. |
|
|
A list of scopes that the access can be used for. |
|
|
Expiration date for the authorization token. Null means no expiration date (default). |
Blacklisted Keys (5)
POST Create a blocked key
/projects/{project_id}/blacklisted_keys
Create a new rule for blocking keys.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Blocked key name |
DELETE Delete a blocked key
/projects/{project_id}/blacklisted_keys/{id}
Delete an existing rule for blocking keys.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
ID |
|
|
N/A |
GET Get a single blocked key
/projects/{project_id}/blacklisted_keys/{id}
Get details on a single rule for blocking keys for a given project.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
ID |
|
|
N/A |
GET List blocked keys
/projects/{project_id}/blacklisted_keys
List all rules for blocking keys for the given project.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
Page number |
|
|
Limit on the number of objects to be returned, between 1 and 100. 25 by default |
|
|
specify the branch to use |
|
|
N/A |
PATCH Update a blocked key
/projects/{project_id}/blacklisted_keys/{id}
Update an existing rule for blocking keys.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
ID |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Blocked key name |
Branches (7)
GET Compare branches
/projects/{project_id}/branches/{name}/compare
Compare branch with main branch.
Note: Comparing a branch may take several minutes depending on the project size.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
name |
|
|
N/A |
POST Create a branch
/projects/{project_id}/branches
Create a new branch.
Note: Creating a new branch may take several minutes depending on the project size.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Name of the branch |
DELETE Delete a branch
/projects/{project_id}/branches/{name}
Delete an existing branch.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
name |
|
|
N/A |
GET Get a single branch
/projects/{project_id}/branches/{name}
Get details on a single branch for a given project.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
name |
|
|
N/A |
GET List branches
/projects/{project_id}/branches
List all branches the of the current project.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
Page number |
|
|
Limit on the number of objects to be returned, between 1 and 100. 25 by default |
|
|
N/A |
PATCH Merge a branch
/projects/{project_id}/branches/{name}/merge
Merge an existing branch.
Note: Merging a branch may take several minutes depending on diff size.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
name |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
strategy used for merge blocking, use_main or use_branch |
PATCH Update a branch
/projects/{project_id}/branches/{name}
Update an existing branch.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
name |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Name of the branch |
Comment Reactions (4)
POST Create a reaction
/projects/{project_id}/keys/{key_id}/comments/{comment_id}/reactions
Create a new reaction for a comment.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
Translation Key ID |
|
|
Comment ID |
|
|
specify the branch to use |
|
|
specify the emoji for the reaction |
|
|
N/A |
DELETE Delete a reaction
/projects/{project_id}/keys/{key_id}/comments/{comment_id}/reactions/{id}
Delete an existing reaction.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
Translation Key ID |
|
|
Comment ID |
|
|
ID |
|
|
specify the branch to use |
|
|
N/A |
GET Get a single reaction
/projects/{project_id}/keys/{key_id}/comments/{comment_id}/reactions/{id}
Get details on a single reaction.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
Translation Key ID |
|
|
Comment ID |
|
|
ID |
|
|
specify the branch to use |
|
|
N/A |
GET List reactions
/projects/{project_id}/keys/{key_id}/comments/{comment_id}/reactions
List all reactions for a comment.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
Translation Key ID |
|
|
Comment ID |
|
|
Page number |
|
|
Limit on the number of objects to be returned, between 1 and 100. 25 by default |
|
|
specify the branch to use |
|
|
N/A |
Comment Replies (6)
POST Create a reply
/projects/{project_id}/keys/{key_id}/comments/{comment_id}/replies
Create a new reply for a comment.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
Translation Key ID |
|
|
Comment ID |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
Reply message body |
|
|
Specify the branch to use |
DELETE Delete a reply
/projects/{project_id}/keys/{key_id}/comments/{comment_id}/replies/{id}
Delete an existing reply.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
Translation Key ID |
|
|
Comment ID |
|
|
ID |
|
|
specify the branch to use |
|
|
N/A |
GET Get a single reply
/projects/{project_id}/keys/{key_id}/comments/{comment_id}/replies/{id}
Get details on a single reply.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
Translation Key ID |
|
|
Comment ID |
|
|
ID |
|
|
specify the branch to use |
|
|
N/A |
GET List replies
/projects/{project_id}/keys/{key_id}/comments/{comment_id}/replies
List all replies for a comment.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
Translation Key ID |
|
|
Comment ID |
|
|
Page number |
|
|
Limit on the number of objects to be returned, between 1 and 100. 25 by default |
|
|
specify the branch to use |
|
|
Search query for comment messages |
|
|
Specify the filter for the comments |
|
|
Order direction. Can be one of: asc, desc. |
|
|
N/A |
PATCH Mark a reply as read
/projects/{project_id}/keys/{key_id}/comments/{comment_id}/replies/{id}/mark_as_read
Mark a reply as read.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
Translation Key ID |
|
|
Comment ID |
|
|
ID |
|
|
specify the branch to use |
|
|
N/A |
PATCH Mark a reply as unread
/projects/{project_id}/keys/{key_id}/comments/{comment_id}/replies/{id}/mark_as_unread
Mark a reply as unread.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
Translation Key ID |
|
|
Comment ID |
|
|
ID |
|
|
specify the branch to use |
|
|
N/A |
Comments (8)
GET Check if comment is read
/projects/{project_id}/keys/{key_id}/comments/{id}/read
Check if comment was marked as read. Returns 204 if read, 404 if unread.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
Translation Key ID |
|
|
ID |
|
|
specify the branch to use |
|
|
N/A |
POST Create a comment
/projects/{project_id}/keys/{key_id}/comments
Create a new comment for a key.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
Translation Key ID |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
Comment message |
|
|
specify the branch to use |
|
|
specify the locales for the comment |
DELETE Delete a comment
/projects/{project_id}/keys/{key_id}/comments/{id}
Delete an existing comment.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
Translation Key ID |
|
|
ID |
|
|
specify the branch to use |
|
|
N/A |
GET Get a single comment
/projects/{project_id}/keys/{key_id}/comments/{id}
Get details on a single comment.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
Translation Key ID |
|
|
ID |
|
|
specify the branch to use |
|
|
N/A |
GET List comments
/projects/{project_id}/keys/{key_id}/comments
List all comments for a key.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
Translation Key ID |
|
|
Page number |
|
|
Limit on the number of objects to be returned, between 1 and 100. 25 by default |
|
|
specify the branch to use |
|
|
Search query for comment messages |
|
|
Search comments by their assigned locales |
|
|
Specify the filter for the comments |
|
|
Order direction. Can be one of: asc, desc. |
|
|
N/A |
PATCH Mark a comment as read
/projects/{project_id}/keys/{key_id}/comments/{id}/read
Mark a comment as read.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
Translation Key ID |
|
|
ID |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
specify the branch to use |
DELETE Mark a comment as unread
/projects/{project_id}/keys/{key_id}/comments/{id}/read
Mark a comment as unread.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
Translation Key ID |
|
|
ID |
|
|
specify the branch to use |
|
|
N/A |
PATCH Update a comment
/projects/{project_id}/keys/{key_id}/comments/{id}
Update an existing comment.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
Translation Key ID |
|
|
ID |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
specify the branch to use |
|
|
Comment message |
Custom Metadata (5)
POST Create a property
/accounts/{account_id}/custom_metadata/properties
Create a new custom metadata property.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Account ID |
|
|
N/A |
Options (5)
|
Option Name |
Description |
|---|---|
|
|
name of the property |
|
|
data type of the property |
|
|
ids of projects that the property belongs to |
|
|
description of property |
|
|
value options of property (only applies to single or multi select properties) |
DELETE Destroy property
/accounts/{account_id}/custom_metadata/properties/{id}
Destroy a custom metadata property of an account.
This endpoint is only available to accounts with advanced plans or above.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Account ID |
|
|
ID |
|
|
N/A |
GET Get a single property
/accounts/{account_id}/custom_metadata/properties/{id}
Get details of a single custom property.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Account ID |
|
|
ID |
|
|
N/A |
GET List properties
/accounts/{account_id}/custom_metadata/properties
List all custom metadata properties for an account.
This endpoint is only available to accounts with advanced plans or above.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Account ID |
|
|
Data Type of Custom Metadata Property |
|
|
id of project that the properties belong to |
|
|
Page number |
|
|
Limit on the number of objects to be returned, between 1 and 100. 25 by default |
|
|
query to find a property by name |
|
|
Sort criteria. Can be one of: name, data_type, created_at. |
|
|
Order direction. Can be one of: asc, desc. |
|
|
N/A |
PATCH Update a property
/accounts/{account_id}/custom_metadata/properties/{id}
Update an existing custom metadata property.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Account ID |
|
|
ID |
|
|
N/A |
Options (4)
|
Option Name |
Description |
|---|---|
|
|
name of the property |
|
|
ids of projects that the property belongs to |
|
|
description of property |
|
|
value options of property (only applies to single or multi select properties) |
Distributions (5)
POST Create a distribution
/accounts/{account_id}/distributions
Create a new distribution.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Account ID |
|
|
N/A |
Options (8)
|
Option Name |
Description |
|---|---|
|
|
Name of the distribution |
|
|
Project id the distribution should be assigned to. |
|
|
List of platforms the distribution should support.
|
|
|
List of locale ids that will be part of distribution releases |
|
|
Use fallback locale if there is no translation in the current locale. |
|
|
Indicates whether to fallback to non regional locale when locale can not be found |
|
|
Indicates whether to fallback to projects default locale when locale can not be found |
|
|
Use last reviewed instead of latest translation in a project |
DELETE Delete a distribution
/accounts/{account_id}/distributions/{id}
Delete an existing distribution.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Account ID |
|
|
ID |
|
|
N/A |
GET Get a single distribution
/accounts/{account_id}/distributions/{id}
Get details on a single distribution.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Account ID |
|
|
ID |
|
|
N/A |
GET List distributions
/accounts/{account_id}/distributions
List all distributions for the given account.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Account ID |
|
|
Page number |
|
|
Limit on the number of objects to be returned, between 1 and 100. 25 by default |
|
|
N/A |
PATCH Update a distribution
/accounts/{account_id}/distributions/{id}
Update an existing distribution.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Account ID |
|
|
ID |
|
|
N/A |
Options (8)
|
Option Name |
Description |
|---|---|
|
|
Name of the distribution |
|
|
Project id the distribution should be assigned to. |
|
|
List of platforms the distribution should support. |
|
|
List of locale ids that will be part of distribution releases |
|
|
Use fallback locale if there is no translation in the current locale. |
|
|
Indicates whether to fallback to non regional locale when locale can not be found |
|
|
Indicates whether to fallback to projects default locale when locale can not be found |
|
|
Use last reviewed instead of latest translation in a project |
Documents (2)
DELETE Delete document
/projects/{project_id}/documents/{id}
Delete an existing document.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
ID |
|
|
N/A |
GET List documents
/projects/{project_id}/documents
List all documents the current user has access to.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Page number |
|
|
Limit on the number of objects to be returned, between 1 and 100. 25 by default |
|
|
Project ID |
|
|
N/A |
Figma attachments (5)
POST Create a Figma attachment
/projects/{project_id}/figma_attachments
Create a new Figma attachment.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
specify the branch to use |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
specify the branch to use |
|
|
Figma file url |
DELETE Delete a Figma attachment
/projects/{project_id}/figma_attachments/{id}
Delete an existing Figma attachment.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
ID |
|
|
specify the branch to use |
|
|
N/A |
GET Get a single Figma attachment
/projects/{project_id}/figma_attachments/{id}
Get details on a single Figma attachment for a given project.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
ID |
|
|
specify the branch to use |
|
|
N/A |
GET List Figma attachments
/projects/{project_id}/figma_attachments
List all Figma attachments for the given project
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
Page number |
|
|
Limit on the number of objects to be returned, between 1 and 100. 25 by default |
|
|
specify the branch to use |
|
|
N/A |
PATCH Update a Figma attachment
/projects/{project_id}/figma_attachments/{id}
Update an existing Figma attachment.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
ID |
|
|
specify the branch to use |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
specify the branch to use |
|
|
Figma file url |
Formats
GET List formats
/formats
Get a handy list of all localization file formats supported in Phrase.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Glossaries (5)
POST Create a term base
/accounts/{account_id}/glossaries
Create a new term base (previously: glossary).
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Account ID |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
Name of the glossary |
|
|
List of project ids the glossary should be assigned to. |
|
|
List of space ids the glossary should be assigned to. |
DELETE Delete a term base
/accounts/{account_id}/glossaries/{id}
Delete an existing term base (previously: glossary).
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Account ID |
|
|
ID |
|
|
N/A |
GET Get a single term base
/accounts/{account_id}/glossaries/{id}
Get details on a single term base (previously: glossary).
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Account ID |
|
|
ID |
|
|
N/A |
GET List term bases
/accounts/{account_id}/glossaries
List all term bases (previously: glossaries) the current user has access to.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Account ID |
|
|
Page number |
|
|
Limit on the number of objects to be returned, between 1 and 100. 25 by default |
|
|
N/A |
PATCH Update a term base
/accounts/{account_id}/glossaries/{id}
Update an existing term base (previously: glossary).
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Account ID |
|
|
ID |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
Name of the glossary |
|
|
List of project ids the glossary should be assigned to. |
|
|
List of space ids the glossary should be assigned to. |
Glossary Term Translations (3)
POST Create a translation for a term
/accounts/{account_id}/glossaries/{glossary_id}/terms/{term_id}/translations
Create a new translation for a term in a term base (previously: glossary).
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Account ID |
|
|
Glossary ID |
|
|
Term ID |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
Identifies the language for this translation |
|
|
The content of the translation |
DELETE Delete a translation for a term
/accounts/{account_id}/glossaries/{glossary_id}/terms/{term_id}/translations/{id}
Delete an existing translation of a term in a term base (previously: glossary).
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Account ID |
|
|
Glossary ID |
|
|
Term ID |
|
|
ID |
|
|
N/A |
PATCH Update a translation for a term
/accounts/{account_id}/glossaries/{glossary_id}/terms/{term_id}/translations/{id}
Update an existing translation for a term in a term base (previously: glossary).
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Account ID |
|
|
Glossary ID |
|
|
Term ID |
|
|
ID |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
Identifies the language for this translation |
|
|
The content of the translation |
Glossary Terms (5)
POST Create a term
/accounts/{account_id}/glossaries/{glossary_id}/terms
Create a new term in a term base (previously: glossary).
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Account ID |
|
|
Glossary ID |
|
|
N/A |
Options (4)
|
Option Name |
Description |
|---|---|
|
|
Glossary term |
|
|
Description of term |
|
|
Indicates whether the term should be used for all languages or can be translated |
|
|
Indicates whether the term is case sensitive |
DELETE Delete a term
/accounts/{account_id}/glossaries/{glossary_id}/terms/{id}
Delete an existing term in a term base (previously: glossary).
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Account ID |
|
|
Glossary ID |
|
|
ID |
|
|
N/A |
GET Get a single term
/accounts/{account_id}/glossaries/{glossary_id}/terms/{id}
Get details for a single term in the term base (previously: glossary).
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Account ID |
|
|
Glossary ID |
|
|
ID |
|
|
N/A |
GET List terms
/accounts/{account_id}/glossaries/{glossary_id}/terms
List all terms in term bases (previously: glossary) that the current user has access to.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Account ID |
|
|
Glossary ID |
|
|
Page number |
|
|
Limit on the number of objects to be returned, between 1 and 100. 25 by default |
|
|
N/A |
PATCH Update a term
/accounts/{account_id}/glossaries/{glossary_id}/terms/{id}
Update an existing term in a term base (previously: glossary).
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Account ID |
|
|
Glossary ID |
|
|
ID |
|
|
N/A |
Options (4)
|
Option Name |
Description |
|---|---|
|
|
Glossary term |
|
|
Description of term |
|
|
Indicates whether the term should be used for all languages or can be translated |
|
|
Indicates whether the term is case sensitive |
ICU
POST Build ICU skeletons
/icu/skeleton
Returns ICU skeletons for multiple locale codes based on a source content.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
N/A |
Options (5)
|
Option Name |
Description |
|---|---|
|
|
Source content |
|
|
Locale codes |
|
|
Keep the content and add missing plural forms for each locale |
|
|
Indicates whether the zero form should be included or excluded in the returned skeletons |
|
|
Strings supports two CLDR variants, when it comes to pluralization rules. \
|
Invitations (7)
POST Create a new invitation
/accounts/{account_id}/invitations
Invite a person to an account. Developers and translators need project_ids and locale_ids assigned to access them. Access token scope must include team.manage.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Account ID |
|
|
N/A |
Options (7)
|
Option Name |
Description |
|---|---|
|
|
The email of the invited user. The email can not be updated once created. Create a new invitation for each unique email. |
|
|
Invitiation role, can be any of Manager, Developer, Translator. |
|
|
List of project ids the invited user has access to. |
|
|
List of locale ids the invited user has access to. |
|
|
List of spaces the user is assigned to. |
|
|
List of teams the user is assigned to. |
|
|
List of default locales for the user. |
DELETE Delete an invitation
/accounts/{account_id}/invitations/{id}
Delete an existing invitation (must not be accepted yet). Access token scope must include team.manage.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Account ID |
|
|
ID |
|
|
N/A |
GET Get a single invitation
/accounts/{account_id}/invitations/{id}
Get details on a single invitation. Access token scope must include team.manage.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Account ID |
|
|
ID |
|
|
N/A |
GET List invitations
/accounts/{account_id}/invitations
List invitations for an account. It will also list the accessible resources like projects and locales the invited user has access to. In case nothing is shown the default access from the role is used. Access token scope must include team.manage.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Account ID |
|
|
Page number |
|
|
Limit on the number of objects to be returned, between 1 and 100. 25 by default |
|
|
N/A |
POST Resend an invitation
/accounts/{account_id}/invitations/{id}/resend
Resend the invitation email (must not be accepted yet). Access token scope must include team.manage.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Account ID |
|
|
ID |
|
|
N/A |
PATCH Update a member's invitation access
/projects/{project_id}/invitations/{id}
Update member's settings in the invitations. Access token scope must include team.manage.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
ID |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
Member role, can be any of of Manager, Developer, Translator |
|
|
List of locale ids the user has access to. |
PATCH Update an invitation
/accounts/{account_id}/invitations/{id}
Update an existing invitation (must not be accepted yet). The email cannot be updated. Developers and translators need project_ids and locale_ids assigned to access them. Access token scope must include team.manage.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Account ID |
|
|
ID |
|
|
N/A |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
Invitiation role, can be any of Manager, Developer, Translator |
|
|
List of project ids the invited user has access to |
|
|
List of locale ids the invited user has access to |
|
|
List of spaces the user is assigned to. |
|
|
List of teams the user is assigned to. |
|
|
List of default locales for the user. |
Job Annotations (6)
PATCH Create/Update a job annotation
/projects/{project_id}/jobs/{job_id}/annotations/{id}
Create or update an annotation for a job. If the annotation already exists, it will be updated; otherwise, a new annotation will be created.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
Job ID |
|
|
Name of the annotation to set or update. |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
Annotation value |
|
|
Branch name of the job |
PATCH Create/Update a job locale annotation
/projects/{project_id}/jobs/{job_id}/locales/{job_locale_id}/annotations/{id}
Create or update an annotation for a job locale. If the annotation already exists, it will be updated; otherwise, a new annotation will be created.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
Job ID |
|
|
Job Locale ID |
|
|
Name of the annotation to set or update. |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
Annotation value |
|
|
Branch name of the job |
DELETE Delete a job annotation
/projects/{project_id}/jobs/{job_id}/annotations/{id}
Delete an annotation for a job.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
Branch to use |
|
|
Job ID |
|
|
Name of the annotation to delete. |
|
|
N/A |
DELETE Delete a job locale annotation
/projects/{project_id}/jobs/{job_id}/locales/{job_locale_id}/annotations/{id}
Delete an annotation for a job locale.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
Branch to use |
|
|
Job ID |
|
|
Job Locale ID |
|
|
Name of the annotation to delete. |
|
|
N/A |
GET List job annotations
/projects/{project_id}/jobs/{job_id}/annotations
Retrieve a list of annotations for a job.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
Branch to use |
|
|
Job ID |
|
|
N/A |
GET List job locale annotations
/projects/{project_id}/jobs/{job_id}/locales/{job_locale_id}/annotations
Retrieve a list of annotations for a job locale.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
Branch to use |
|
|
Job ID |
|
|
Job Locale ID |
|
|
N/A |
Job Comments (5)
POST Create a job comment
/projects/{project_id}/jobs/{job_id}/comments
Create a new comment for a job.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
Job ID |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
Job comment message |
|
|
Branch name for the job |
DELETE Delete a job comment
/projects/{project_id}/jobs/{job_id}/comments/{id}
Delete an existing job comment.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
Job ID |
|
|
ID |
|
|
Branch to use |
|
|
N/A |
GET Get a single job comment
/projects/{project_id}/jobs/{job_id}/comments/{id}
Get details on a single job comment.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
Job ID |
|
|
ID |
|
|
Branch to use |
|
|
N/A |
GET List job comments
/projects/{project_id}/jobs/{job_id}/comments
List all comments for a job.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
Job ID |
|
|
Branch to use |
|
|
Order direction. Can be one of: asc, desc. |
|
|
N/A |
PATCH Update a job comment
/projects/{project_id}/jobs/{job_id}/comments/{id}
Update an existing job comment.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
Translation Key ID |
|
|
ID |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
Comment message |
|
|
Branch name for the job |
Job Locales (8)
POST Add a target locale to a job
/projects/{project_id}/jobs/{job_id}/locales
Adds a target locale to a job.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
Job ID |
|
|
N/A |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
specify the branch to use |
|
|
ID of a locale to be added |
|
|
Array of user ids to be assigned to the job locale as translators |
|
|
Array of reviewer ids to be assigned to the job locale as reviewers |
|
|
Array of team ids to be assigned to the job locale as translators |
|
|
Array of team ids to be assigned to the job locale as reviewers |
POST Complete a job locale
/projects/{project_id}/jobs/{job_id}/locales/{id}/complete
Mark a job locale as completed.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
Job ID |
|
|
ID |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
specify the branch to use |
GET List job target locales
/projects/{project_id}/jobs/{job_id}/locales
List all target locales for a given job.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
Job ID |
|
|
Page number |
|
|
Limit on the number of objects to be returned, between 1 and 100. 25 by default |
|
|
Branch to use |
|
|
Include job-locale annotations in the response |
|
|
N/A |
DELETE Remove a target locale from a job
/projects/{project_id}/jobs/{job_id}/locales/{id}
Removes a target locale from a job.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
Job ID |
|
|
ID |
|
|
Branch to use |
|
|
N/A |
POST Reopen a job locale
/projects/{project_id}/jobs/{job_id}/locales/{id}/reopen
Mark a job locale as uncompleted.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
Job ID |
|
|
ID |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
specify the branch to use |
POST Review a job locale
/projects/{project_id}/jobs/{job_id}/locales/{id}/complete_review
Mark job locale as reviewed.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
Job ID |
|
|
ID |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
specify the branch to use |
GET Show single job target locale
/projects/{project_id}/jobs/{job_id}/locales/{id}
Get a single target locale for a given job.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
Job ID |
|
|
ID |
|
|
Branch to use |
|
|
Include job-locale annotations in the response |
|
|
N/A |
PATCH Update a job target locale
/projects/{project_id}/jobs/{job_id}/locales/{id}
Update an existing job target locale.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
Job ID |
|
|
ID |
|
|
N/A |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
specify the branch to use |
|
|
ID of a target locale to update |
|
|
Array of user ids to be assigned to the job locale |
|
|
Array of reviewer ids to be assigned to the job locale as reviewers |
|
|
Array of team ids to be assigned to the job locale as translators |
|
|
Array of team ids to be assigned to the job locale as reviewers |
Job Template Locales (5)
POST Create a job template locale
/projects/{project_id}/job_templates/{job_template_id}/locales
Create a new job template locale.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
Job Template ID |
|
|
N/A |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
specify the branch to use |
|
|
locale id |
|
|
Array of user ids to be assigned to the job template locale |
|
|
Array of reviewer ids to be assigned to the job template locale |
|
|
Array of team ids to be assigned to the job locale as translators |
|
|
Array of team ids to be assigned to the job locale as reviewers |
DELETE Delete a job template locale
/projects/{project_id}/job_templates/{job_template_id}/locales/{job_template_locale_id}
Delete an existing job template locale.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
Job Template ID |
|
|
Job Template Locale ID |
|
|
specify the branch to use |
|
|
N/A |
GET Get a single job template locale
/projects/{project_id}/job_templates/{job_template_id}/locales/{job_template_locale_id}
Get a single job template locale for a given job template.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
Job Template ID |
|
|
Job Template Locale ID |
|
|
specify the branch to use |
|
|
N/A |
GET List job template locales
/projects/{project_id}/job_templates/{job_template_id}/locales
List all job template locales for a given job template.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
Job Template ID |
|
|
Page number |
|
|
Limit on the number of objects to be returned, between 1 and 100. 25 by default |
|
|
specify the branch to use |
|
|
N/A |
PATCH Update a job template locale
/projects/{project_id}/job_templates/{job_template_id}/locales/{job_template_locale_id}
Update an existing job template locale.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
Job Template ID |
|
|
Job Template Locale ID |
|
|
N/A |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
specify the branch to use |
|
|
locale id |
|
|
Array of user ids to be assigned to the job template locale |
|
|
Array of reviewer ids to be assigned to the job template locale |
|
|
Array of team ids to be assigned to the job locale as translators |
|
|
Array of team ids to be assigned to the job locale as reviewers |
Job Templates (5)
POST Create a job template
/projects/{project_id}/job_templates
Create a new job template.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
specify the branch to use |
|
|
Job template name |
|
|
Briefing for the translators |
DELETE Delete a job template
/projects/{project_id}/job_templates/{id}
Delete an existing job template.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
ID |
|
|
specify the branch to use |
|
|
N/A |
GET Get a single job template
/projects/{project_id}/job_templates/{id}
Get details on a single job template for a given project.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
ID |
|
|
specify the branch to use |
|
|
N/A |
GET List job templates
/projects/{project_id}/job_templates
List all job templates for the given project.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
Page number |
|
|
Limit on the number of objects to be returned, between 1 and 100. 25 by default |
|
|
specify the branch to use |
|
|
N/A |
PATCH Update a job template
/projects/{project_id}/job_templates/{id}
Update an existing job template.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
ID |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
specify the branch to use |
|
|
Job template name |
|
|
Briefing for the translators |
Jobs (13)
POST Add keys to job
/projects/{project_id}/jobs/{id}/keys
Add multiple keys to a existing job.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
ID |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
specify the branch to use |
|
|
ids of keys that should added to the job |
POST Complete a job
/projects/{project_id}/jobs/{id}/complete
Mark a job as completed.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
ID |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
specify the branch to use |
POST Create a job
/projects/{project_id}/jobs
Create a new job.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
N/A |
Options (9)
|
Option Name |
Description |
|---|---|
|
|
specify the branch to use |
|
|
Job name |
|
|
The API id of the source language |
|
|
Briefing for the translators |
|
|
Date the job should be finished |
|
|
URL to a ticket for this job (e.g. Jira, Trello) |
|
|
tags of keys that should be included within the job |
|
|
ids of keys that should be included within the job |
|
|
id of a job template you would like to model the created job after. Any manually added parameters will take preference over template attributes. |
DELETE Delete a job
/projects/{project_id}/jobs/{id}
Delete an existing job.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
ID |
|
|
specify the branch to use |
|
|
N/A |
GET Get a single job
/projects/{project_id}/jobs/{id}
Get details on a single job for a given project.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
ID |
|
|
Branch to use |
|
|
Include job-locale annotations in the response |
|
|
N/A |
GET List account jobs
/accounts/{account_id}/jobs
List all jobs for the given account.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Account ID |
|
|
Page number |
|
|
Limit on the number of objects to be returned, between 1 and 100. 25 by default |
|
|
filter by user owning job |
|
|
filter by user assigned to job |
|
|
filter by state of job; valid states are: draft, in_progress, completed |
|
|
filter by jobs updated since given date |
|
|
N/A |
GET List jobs
/projects/{project_id}/jobs
List all jobs for the given project.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
Page number |
|
|
Limit on the number of objects to be returned, between 1 and 100. 25 by default |
|
|
Branch to use |
|
|
filter by user owning job |
|
|
filter by user assigned to job |
|
|
filter by state of job; valid states are: draft, in_progress, completed |
|
|
filter by jobs updated since given date |
|
|
N/A |
POST Lock a job
/projects/{project_id}/jobs/{id}/lock
If you are the job owner, you may lock a job using this API request.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
ID |
|
|
specify the branch to use |
|
|
N/A |
DELETE Remove keys from job
/projects/{project_id}/jobs/{id}/keys
Remove multiple keys from existing job.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
ID |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
specify the branch to use |
|
|
ids of keys that should be deleted from the job |
POST Reopen a job
/projects/{project_id}/jobs/{id}/reopen
Mark a job as uncompleted.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
ID |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
specify the branch to use |
POST Start a job
/projects/{project_id}/jobs/{id}/start
Starts an existing job in state draft.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
ID |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
specify the branch to use |
POST Unlock a job
/projects/{project_id}/jobs/{id}/unlock
If you are the job owner, you may unlock a locked job using this API request.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
ID |
|
|
specify the branch to use |
|
|
N/A |
PATCH Update a job
/projects/{project_id}/jobs/{id}
Update an existing job.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
ID |
|
|
N/A |
Options (5)
|
Option Name |
Description |
|---|---|
|
|
specify the branch to use |
|
|
Job name |
|
|
Briefing for the translators |
|
|
Date the job should be finished |
|
|
URL to a ticket for this job (e.g. Jira, Trello) |
Key's Figma attachments (2)
POST Attach the Figma attachment to a key
/projects/{project_id}/figma_attachments/{figma_attachment_id}/keys
Attach the Figma attachment to a key
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
Figma attachment ID |
|
|
ID |
|
|
specify the branch to use |
|
|
N/A |
DELETE Detach the Figma attachment from a key
/projects/{project_id}/figma_attachments/{figma_attachment_id}/keys/{id}
Detach the Figma attachment from a key
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
Figma attachment ID |
|
|
ID |
|
|
specify the branch to use |
|
|
N/A |
Keys (11)
PATCH Add tags to collection of keys
/projects/{project_id}/keys/tag
Tags all keys matching query. Same constraints as list.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
N/A |
Options (4)
|
Option Name |
Description |
|---|---|
|
|
specify the branch to use |
|
|
Specify a query to do broad search for keys by name (including wildcards). The following qualifiers are also supported in the search term: ids:key_id,... for queries on a comma-separated list of ids
Find more examples here. |
|
|
Locale used to determine the translation state of a key when filtering for untranslated or translated keys. |
|
|
Tag or comma-separated list of tags to add to the matching collection of keys |
POST Create a key
/projects/{project_id}/keys
Create a new key.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
N/A |
Options (19)
|
Option Name |
Description |
|---|---|
|
|
specify the branch to use |
|
|
Key name |
|
|
Key description (usually includes contextual information for translators) |
|
|
Indicates whether key supports pluralization |
|
|
Indicates whether key uses ordinal rules for pluralization |
|
|
Plural name for the key (used in some file formats, e.g. Gettext) |
|
|
Type of the key. Can be one of the following: string, number, boolean, array, markdown. |
|
|
List of tags separated by comma to be associated with the key. |
|
|
Max. number of characters translations for this key can have. |
|
|
Screenshot/image for the key. This parameter is deprecated. Please use the Screenshots endpoint instead. |
|
|
Indicates whether the screenshot will be deleted. This parameter is deprecated. Please use the Screenshots endpoint instead. |
|
|
Indicates whether the key should be exported as "unformatted". Supported by Android XML and other formats. |
|
|
Creates a translation in the default locale with the specified content |
|
|
Indicates whether the key should be autotranslated to other locales based on the copy provided in default_translation_content. |
|
|
Indicates whether the key should be exported with "xml:space=preserve". Supported by several XML-based formats. |
|
|
Original file attribute. Used in some formats, e.g. XLIFF. |
|
|
NSStringLocalizedFormatKey attribute. Used in .stringsdict format. |
|
|
NSStringLocalizedFormatKey attribute. Used in .stringsdict format. |
|
|
Custom metadata property name and value pairs to be associated with key. |
DELETE Delete a key
/projects/{project_id}/keys/{id}
Delete an existing key.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
ID |
|
|
specify the branch to use |
|
|
N/A |
DELETE Delete collection of keys
/projects/{project_id}/keys
Delete all keys matching query. Same constraints as list. Please limit the number of affected keys to about 1,000 as you might experience timeouts otherwise.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
specify the branch to use |
|
|
Specify a query to do broad search for keys by name (including wildcards). The following qualifiers are also supported in the search term:
Caution: Query parameters with empty values will be treated as though they are not included in the request and will be ignored. Find more examples here. |
|
|
Locale used to determine the translation state of a key when filtering for untranslated or translated keys. |
|
|
N/A |
PATCH Exclude a locale on a collection of keys
/projects/{project_id}/keys/exclude
Exclude a locale on keys matching query. Same constraints as list.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
N/A |
Options (4)
|
Option Name |
Description |
|---|---|
|
|
specify the branch to use |
|
|
Specify a query to do broad search for keys by name (including wildcards). The following qualifiers are also supported in the search term:
Find more examples here. |
|
|
Locale used to exlcude or include keys. |
|
|
Tag or comma-separated list of tags to add to the matching collection of keys |
GET Get a single key
/projects/{project_id}/keys/{id}
Get details on a single key for a given project.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
ID |
|
|
specify the branch to use |
|
|
N/A |
PATCH Include a locale on a collection of keys
/projects/{project_id}/keys/include
Include a locale on keys matching query. Same constraints as list.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
N/A |
Options (4)
|
Option Name |
Description |
|---|---|
|
|
specify the branch to use |
|
|
Specify a query to do broad search for keys by name (including wildcards). The following qualifiers are also supported in the search term: ids:key_id,... for queries on a comma-separated list of ids
Find more examples here. |
|
|
Locale used to exlcude or include keys. |
|
|
Tag or comma-separated list of tags to add to the matching collection of keys |
GET List keys
/projects/{project_id}/keys
List all keys for the given project. Alternatively you can POST requests to /search.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
Page number |
|
|
Limit on the number of objects to be returned, between 1 and 100. 25 by default |
|
|
specify the branch to use |
|
|
Sort by field. Can be one of: name, created_at, updated_at. |
|
|
Order direction. Can be one of: asc, desc. |
|
|
Specify a query to do broad search for keys by name (including wildcards). The following qualifiers are also supported in the search term:
Caution: Query parameters with empty values will be treated as though they are not included in the request and will be ignored. Find more examples here. |
|
|
Locale used to determine the translation state of a key when filtering for untranslated or translated keys. |
|
|
N/A |
PATCH Remove tags from collection of keys
/projects/{project_id}/keys/untag
Removes specified tags from keys matching query.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
N/A |
Options (4)
|
Option Name |
Description |
|---|---|
|
|
specify the branch to use |
|
|
Specify a query to do broad search for keys by name (including wildcards). The following qualifiers are also supported in the search term:
Find more examples here. |
|
|
Locale used to determine the translation state of a key when filtering for untranslated or translated keys. |
|
|
Tag or comma-separated list of tags to remove from the matching collection of keys |
POST Search keys
/projects/{project_id}/keys/search
Search keys for the given project matching query.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
Page number |
|
|
Limit on the number of objects to be returned, between 1 and 100. 25 by default |
|
|
N/A |
Options (5)
|
Option Name |
Description |
|---|---|
|
|
specify the branch to use |
|
|
Sort by field. Can be one of: name, created_at, updated_at. |
|
|
Order direction. Can be one of: asc, desc. |
|
|
Specify a query to do broad search for keys by name (including wildcards). The following qualifiers are also supported in the search term: ids:key_id,... for queries on a comma-separated list of ids
Find more examples here.
|
|
|
Locale used to determine the translation state of a key when filtering for untranslated or translated keys. |
PATCH Update a key
/projects/{project_id}/keys/{id}
Update an existing key.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
ID |
|
|
N/A |
Options (17)
|
Option Name |
Description |
|---|---|
|
|
specify the branch to use |
|
|
Key name |
|
|
Key description (usually includes contextual information for translators) |
|
|
Indicates whether key supports pluralization |
|
|
Indicates whether key uses ordinal rules for pluralization |
|
|
Plural name for the key (used in some file formats, e.g. Gettext) |
|
|
Type of the key. Can be one of the following: string, number, boolean, array, markdown. |
|
|
List of tags separated by comma to be associated with the key. |
|
|
Max. number of characters translations for this key can have. |
|
|
Screenshot/image for the key. This parameter is deprecated. Please use the Screenshots endpoint instead. |
|
|
Indicates whether the screenshot will be deleted. This parameter is deprecated. Please use the Screenshots endpoint instead. |
|
|
Indicates whether the key should be exported as "unformatted". Supported by Android XML and other formats. |
|
|
Indicates whether the key should be exported with "xml:space=preserve". Supported by several XML-based formats. |
|
|
Original file attribute. Used in some formats, e.g. XLIFF. |
|
|
NSStringLocalizedFormatKey attribute. Used in .stringsdict format. |
|
|
NSStringLocalizedFormatKey attribute. Used in .stringsdict format. |
|
|
Updates/Creates custom metadata property name and value pairs to be associated with key. If you want to delete a custom metadata property, you can set its value to null. If you want to update a custom metadata property, you can set its value to the new value. |
Linked Keys (4)
DELETE Batch unlink child keys from a parent key
/projects/{project_id}/keys/{id}/key_links
Unlinks multiple child keys from a given parent key in a single operation.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
Parent Translation Key ID |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The IDs of the child keys to unlink from the parent key. |
|
|
Whether to unlink the parent key as well and unmark it as linked-key. |
POST Link child keys to a parent key
/projects/{project_id}/keys/{id}/key_links
Creates links between a given parent key and one or more child keys.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
Parent Translation Key ID |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The IDs of the child keys to link to the parent key. Can be left empty, to only mark the given translation-key as parent |
GET List child keys of a parent key
/projects/{project_id}/keys/{id}/key_links
Returns detailed information about a parent key, including its linked child keys.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
Parent Translation Key ID |
|
|
N/A |
DELETE Unlink a child key from a parent key
/projects/{project_id}/keys/{id}/key_links/{child_key_id}
Unlinks a single child key from a given parent key.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
Parent Translation Key ID |
|
|
The ID of the child key to unlink. |
|
|
N/A |
Locale Downloads (2)
POST Initiate async download of a locale
/projects/{project_id}/locales/{locale_id}/downloads
Prepare a locale for download in a specific file format.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Last modified condition, see Conditional GET requests / HTTP Caching (optional) |
|
|
ETag condition, see Conditional GET requests / HTTP Caching (optional) |
|
|
Project ID |
|
|
Locale ID |
|
|
N/A |
Options (16)
|
Option Name |
Description |
|---|---|
|
|
File format name. See the format guide for all supported file formats. |
|
|
specify the branch to use |
|
|
Limit results to keys tagged with a list of comma separated tag names. |
|
|
Indicates whether keys without translations should be included in the output as well. |
|
|
Indicates whether zero forms should be included when empty in pluralized keys. |
|
|
Include translated keys in the locale file. Use in combination with include_empty_translations to obtain only untranslated keys. |
|
|
Indicates whether [NOTRANSLATE] tags should be kept. |
|
|
Additional formatting and render options. See the format guide for a list of options available for each format. Specify format options like this: ...&format_options[foo]=bar |
|
|
Enforces a specific encoding on the file contents. Valid options are "UTF-8", "UTF-16" and "ISO-8859-1". |
|
|
if set to false unverified translations are excluded |
|
|
If set to true the last reviewed version of a translation is used. This is only available if the review workflow is enabled for the project. |
|
|
Locale IDs or locale names |
|
|
If a key has no translation in the locale being downloaded the translation in the fallback locale will be used. Provide the ID of the locale that should be used as the fallback. Requires include_empty_translations to be set to true. |
|
|
Provides the source language of a corresponding job as the source language of the generated locale file. This parameter will be ignored unless used in combination with a tag parameter indicating a specific job. |
|
|
Custom metadata filters. Provide the name of the metadata field and the value to filter by. Only keys with matching metadata will be included in the download. |
|
|
Only include translations and keys that have been updated since the given date. The date must be in ISO 8601 format (e.g., 2023-01-01T00:00:00Z). |
GET Show status of an async locale download
/projects/{project_id}/locales/{locale_id}/downloads/{id}
Show status of already started async locale download. If the download is finished, the download link will be returned.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Last modified condition, see Conditional GET requests / HTTP Caching (optional) |
|
|
ETag condition, see Conditional GET requests / HTTP Caching (optional) |
|
|
Project ID |
|
|
Locale ID |
|
|
ID |
|
|
N/A |
Locales (7)
POST Create a locale
/projects/{project_id}/locales
Create a new locale.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
N/A |
Options (11)
|
Option Name |
Description |
|---|---|
|
|
specify the branch to use |
|
|
Locale name |
|
|
Locale ISO code |
|
|
Indicates whether locale is the default locale. If set to true, the previous default locale the project is no longer the default locale. |
|
|
Indicates whether locale is a main locale. Main locales are part of the Verification System feature. |
|
|
Indicates whether locale is a RTL (Right-to-Left) locale. |
|
|
Source locale. Can be the name or id of the locale. Preferred is id. |
|
|
Fallback locale for empty translations. Can be a locale name or id. |
|
|
Indicates that new translations for this locale should be marked as unverified. Part of the Advanced Workflows feature. |
|
|
Indicates that updated translations for this locale should be marked as unverified. Part of the Advanced Workflows feature. |
|
|
If set, translations for this locale will be fetched automatically, right after creation. |
DELETE Delete a locale
/projects/{project_id}/locales/{id}
Delete an existing locale.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
Locale ID or locale name |
|
|
specify the branch to use |
|
|
N/A |
GET Download a locale
/projects/{project_id}/locales/{id}/download
Download a locale in a specific file format.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Last modified condition, see Conditional GET requests / HTTP Caching (optional) |
|
|
ETag condition, see Conditional GET requests / HTTP Caching (optional) |
|
|
Project ID |
|
|
Locale ID or locale name |
|
|
specify the branch to use |
|
|
File format name. See the format guide for all supported file formats. |
|
|
Limit results to keys tagged with a list of comma separated tag names. |
|
|
Limit download to tagged keys. This parameter is deprecated. Please use the "tags" parameter instead |
|
|
Indicates whether keys without translations should be included in the output as well. |
|
|
Indicates whether zero forms should be included when empty in pluralized keys. |
|
|
Include translated keys in the locale file. Use in combination with include_empty_translations to obtain only untranslated keys. |
|
|
Indicates whether [NOTRANSLATE] tags should be kept. |
|
|
This option is obsolete. Projects that were created on or after Nov 29th 2019 or that did not contain emoji by then will not require this flag any longer since emoji are now supported natively. |
|
|
Additional formatting and render options. See the format guide for a list of options available for each format. Specify format options like this: ...&format_options[foo]=bar |
|
|
Enforces a specific encoding on the file contents. Valid options are "UTF-8", "UTF-16" and "ISO-8859-1". |
|
|
Indicates whether the locale file should skip all unverified translations. This parameter is deprecated and should be replaced with include_unverified_translations. |
|
|
if set to false unverified translations are excluded |
|
|
If set to true the last reviewed version of a translation is used. This is only available if the review workflow is enabled for the project. |
|
|
If a key has no translation in the locale being downloaded the translation in the fallback locale will be used. Provide the ID of the locale that should be used as the fallback. Requires include_empty_translations to be set to true. |
|
|
Provides the source language of a corresponding job as the source language of the generated locale file. This parameter will be ignored unless used in combination with a tag parameter indicating a specific job. |
|
|
Download all translation keys, and remove the specified prefix where possible. Warning: this may create duplicate key names if other keys share the same name after the prefix is removed. |
|
|
Only download translation keys containing the specified prefix, and remove the prefix from the generated file. |
|
|
Custom metadata filters. Provide the name of the metadata field and the value to filter by. Only keys with matching metadata will be included in the download. |
|
|
Locale IDs or locale names |
|
|
Only include translations and keys that have been updated since the given date. The date must be in ISO 8601 format (e.g., 2023-01-01T00:00:00Z). |
|
|
N/A |
GET Get a single locale
/projects/{project_id}/locales/{id}
Get details on a single locale for a given project.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
Locale ID or locale name |
|
|
specify the branch to use |
|
|
N/A |
GET List locales
/projects/{project_id}/locales
List all locales for the given project.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
Page number |
|
|
Limit on the number of objects to be returned, between 1 and 100. 25 by default |
|
|
Sort locales. Valid options are "name_asc", "name_desc", "default_asc", "default_desc". |
|
|
specify the branch to use |
|
|
N/A |
GET List locales used in account
/accounts/{id}/locales
List all locales unique by locale code used across all projects within an account.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
ID |
|
|
Page number |
|
|
Limit on the number of objects to be returned, between 1 and 100. 25 by default |
|
|
N/A |
PATCH Update a locale
/projects/{project_id}/locales/{id}
Update an existing locale.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
Locale ID or locale name |
|
|
N/A |
Options (11)
|
Option Name |
Description |
|---|---|
|
|
specify the branch to use |
|
|
Locale name |
|
|
Locale ISO code |
|
|
Indicates whether locale is the default locale. If set to true, the previous default locale the project is no longer the default locale. |
|
|
Indicates whether locale is a main locale. Main locales are part of the Verification System feature. |
|
|
Indicates whether locale is a RTL (Right-to-Left) locale. |
|
|
Source locale. Can be the name or id of the locale. Preferred is id. |
|
|
Fallback locale for empty translations. Can be a locale name or id. |
|
|
Indicates that new translations for this locale should be marked as unverified. Part of the Advanced Workflows feature. |
|
|
Indicates that updated translations for this locale should be marked as unverified. Part of the Advanced Workflows feature. |
|
|
If set, translations for this locale will be fetched automatically, right after creation. |
Members (5)
GET Get single member
/accounts/{account_id}/members/{id}
Get details on a single user in the account. Access token scope must include team.manage.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Account ID |
|
|
ID |
|
|
N/A |
GET List members
/accounts/{account_id}/members
Get all users active in the account. It also lists resources like projects and locales the member has access to. In case nothing is shown the default access from the role is used. Access token scope must include team.manage.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Account ID |
|
|
Page number |
|
|
Limit on the number of objects to be returned, between 1 and 100. 25 by default |
|
|
N/A |
DELETE Remove a user from the account
/accounts/{account_id}/members/{id}
Remove a user from the account. The user will be removed from the account but not deleted from Phrase. Access token scope must include team.manage.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Account ID |
|
|
ID |
|
|
N/A |
PATCH Update a member
/accounts/{account_id}/members/{id}
Update user permissions in the account. Developers and translators need project_ids and locale_ids assigned to access them. Access token scope must include team.manage.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Account ID |
|
|
ID |
|
|
N/A |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
Update strategy, can be any of set, add, remove. If provided, it will set, add or remove given spaces, projects and locale ids from users access list. |
|
|
Member role, can be any of of Admin, ProjectManager, Developer, Designer, Translator |
|
|
List of project ids the user has access to. |
|
|
List of locale ids the user has access to. |
|
|
List of default locales for the user. |
|
|
List of spaces the user is assigned to. |
PATCH Update a member's project settings
/projects/{project_id}/members/{id}
Update user settings in the project. Access token scope must include team.manage.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
ID |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
Member role, can be any of of Manager, Developer, Translator |
|
|
List of locale ids the user has access to. |
Notification Groups (3)
GET List notification groups
/notification_groups
List all notification groups from the current user
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Page number |
|
|
Limit on the number of objects to be returned, between 1 and 100. 25 by default |
|
|
N/A |
PATCH Mark a notification group as read
/notification_groups/{id}/mark_as_read
Mark a notifications group of the current user as read
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
ID |
|
|
N/A |
PATCH Mark all notification groups as read
/notification_groups/mark_all_as_read
Mark all notification groups of the current user as read
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
N/A |
Notifications (3)
GET Get a single notification
/notifications/{id}
Get details on a single notification.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
ID |
|
|
N/A |
GET List notifications
/notifications
List all notifications from the current user
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Page number |
|
|
Limit on the number of objects to be returned, between 1 and 100. 25 by default |
|
|
Include only unseen notifications |
|
|
N/A |
POST Mark all notifications as read
/notifications/mark_all_as_read
Mark all notifications of the current user as read
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
N/A |
Orders (5)
DELETE Cancel an order
/projects/{project_id}/orders/{id}
Cancel an existing order. Must not yet be confirmed.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
ID |
|
|
specify the branch to use |
|
|
N/A |
PATCH Confirm an order
/projects/{project_id}/orders/{id}/confirm
Confirm an existing order and send it to the provider for translation. Same constraints as for create.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
ID |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
specify the branch to use |
POST Create a new order
/projects/{project_id}/orders
Create a new order. Access token scope must include orders.create.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
N/A |
Options (15)
|
Option Name |
Description |
|---|---|
|
|
specify the branch to use |
|
|
the name of the order, default name is: Translation order from 'current datetime' |
|
|
Name of the LSP that should process this order. Can be one of gengo, textmaster. |
|
|
Source locale for the order. Can be the name or id of the source locale. Preferred is id. |
|
|
List of target locales you want the source content translate to. Can be the name or id of the target locales. Preferred is id. |
|
|
Name of the quality level, availability depends on the LSP. Can be one of: standard, pro (for orders processed by Gengo) and one of regular, premium, enterprise (for orders processed by TextMaster) |
|
|
Tag you want to order translations for. |
|
|
Message that is displayed to the translators for description. |
|
|
Style guide for translators to be sent with the order. |
|
|
Unverify translations upon delivery. |
|
|
Order translations for keys with untranslated content in the selected target locales. |
|
|
Order translations for keys with unverified content in the selected target locales. |
|
|
Category to use (required for orders processed by TextMaster). |
|
|
Extra proofreading option to ensure consistency in vocabulary and style. Only available for orders processed by TextMaster. |
|
|
Indicates whether the priority option should be ordered which decreases turnaround time by 30%. Available only for orders processed by TextMaster. |
GET Get a single order
/projects/{project_id}/orders/{id}
Get details on a single order.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
ID |
|
|
specify the branch to use |
|
|
N/A |
GET List orders
/projects/{project_id}/orders
List all orders for the given project.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
Page number |
|
|
Limit on the number of objects to be returned, between 1 and 100. 25 by default |
|
|
specify the branch to use |
|
|
N/A |
Organization Job Template Locales (5)
POST Create an organization job template locale
/accounts/{account_id}/job_templates/{job_template_id}/locales
Create a new organization job template locale.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Account ID |
|
|
Job Template ID |
|
|
N/A |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
locale name |
|
|
locale code |
|
|
Array of user ids to be assigned to the job template locale |
|
|
Array of reviewer ids to be assigned to the job template locale |
|
|
Array of team ids to be assigned to the job locale as translators |
|
|
Array of team ids to be assigned to the job locale as reviewers |
DELETE Delete an organization job template locale
/accounts/{account_id}/job_templates/{job_template_id}/locales/{job_template_locale_id}
Delete an existing organization job template locale.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Account ID |
|
|
Job Template ID |
|
|
Job Template Locale ID |
|
|
N/A |
GET Get a single organization job template locale
/accounts/{account_id}/job_templates/{job_template_id}/locales/{job_template_locale_id}
Get a single job template locale for a given organization job template.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Account ID |
|
|
Job Template ID |
|
|
Job Template Locale ID |
|
|
N/A |
GET List organization job template locales
/accounts/{account_id}/job_templates/{job_template_id}/locales
List all job template locales for a given organization job template.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Account ID |
|
|
Job Template ID |
|
|
Page number |
|
|
Limit on the number of objects to be returned, between 1 and 100. 25 by default |
|
|
N/A |
PATCH Update an organization job template locale
/accounts/{account_id}/job_templates/{job_template_id}/locales/{job_template_locale_id}
Update an existing organization job template locale.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Account ID |
|
|
Job Template ID |
|
|
Job Template Locale ID |
|
|
N/A |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
locale name |
|
|
locale code |
|
|
Array of user ids to be assigned to the job template locale |
|
|
Array of reviewer ids to be assigned to the job template locale |
|
|
Array of team ids to be assigned to the job locale as translators |
|
|
Array of team ids to be assigned to the job locale as reviewers |
Organization Job Templates (5)
POST Create an organization job template
/accounts/{account_id}/job_templates
Create a new organization job template.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Account ID |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
Job template name |
|
|
Briefing for the translators |
DELETE Delete an organization job template
/accounts/{account_id}/job_templates/{id}
Delete an existing organization job template.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Account ID |
|
|
ID |
|
|
N/A |
GET Get a single organization job template
/accounts/{account_id}/job_templates/{id}
Get details on a single organization job template for a given account.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Account ID |
|
|
ID |
|
|
N/A |
GET List organization job templates
/accounts/{account_id}/job_templates
List all job templates for the given account.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Account ID |
|
|
Page number |
|
|
Limit on the number of objects to be returned, between 1 and 100. 25 by default |
|
|
N/A |
PATCH Update an organization job template
/accounts/{account_id}/job_templates/{id}
Update an existing organization job template.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Account ID |
|
|
ID |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
Job template name |
|
|
Briefing for the translators |
Projects (5)
POST Create a project
/projects
Create a new project.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
N/A |
Options (23)
|
Option Name |
Description |
|---|---|
|
|
Name of the project |
|
|
Main file format specified by its API Extension name. Used for locale downloads if no format is specified. For API Extension names of available file formats see Format Guide (https://support.phrase.com/hc/en-us/sections/6111343326364) or our Formats API Endpoint (/en/api/strings/formats/list-formats). |
|
|
(Optional) Main technology stack used in the project. It affects for example the suggested placeholder style. Predefined values include: Ruby, JavaScript, AngularJS, React, iOS, Android, Python, PHP, Java, Go, Windows Phone, Rails, Node.js, .NET, Django, Symfony, Yii Framework, Zend Framework, Apple App Store Description, Google Play Description, but it can also take any other value. |
|
|
Indicates whether the project should share the account's translation memory |
|
|
Image to identify the project |
|
|
Indicates whether the project image should be deleted. |
|
|
Account ID to specify the actual account the project should be created in. Required if the requesting user is a member of multiple accounts. |
|
|
(Optional) User ID of the point of contact for the project. |
|
|
When a source project ID is given, a clone of that project will be created, including all locales, keys and translations as well as the main project settings if they are not defined otherwise through the params. |
|
|
(Optional) Review Workflow. "simple" / "review". Read more |
|
|
(Optional) Enable machine translation support in the project. Required for Pre-Translation |
|
|
(Optional) Enable branching in the project |
|
|
(Optional) Protect the master branch in project where branching is enabled |
|
|
(Optional) Otherwise, translators are not allowed to edit translations other than strings |
|
|
(Optional) We can validate and highlight your ICU messages. Read more |
|
|
(Optional) Displays the input fields for the 'ZERO' plural form for every key as well although only some languages require the 'ZERO' explicitly. |
|
|
(Optional) Autopilot, requires machine_translation_enabled. Read more |
|
|
(Optional) Requires autotranslate_enabled to be true |
|
|
(Optional) Requires autotranslate_enabled to be true |
|
|
(Optional) Requires autotranslate_enabled to be true |
|
|
(Optional) Requires autotranslate_enabled to be true |
|
|
(Optional) Requires autotranslate_enabled to be true |
|
|
(Optional) Requires autotranslate_enabled to be true |
DELETE Delete a project
/projects/{id}
Delete an existing project.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
ID |
|
|
N/A |
GET Get a single project
/projects/{id}
Get details on a single project.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
ID |
|
|
N/A |
GET List projects
/projects
List all projects the current user has access to.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Page number |
|
|
Limit on the number of objects to be returned, between 1 and 100. 25 by default |
|
|
Filter by Account ID |
|
|
Sort projects. Valid options are "name_asc", "name_desc", "updated_at_asc", "updated_at_desc", "space_asc" and "space_desc". |
|
|
Filter projects. Valid options are ["favorites"]. |
|
|
N/A |
PATCH Update a project
/projects/{id}
Update an existing project.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
ID |
|
|
N/A |
Options (23)
|
Option Name |
Description |
|---|---|
|
|
Required if the requesting user is a member of multiple accounts. Account ID to specify the actual account the project should be created in. |
|
|
(Optional) Name of the project |
|
|
(Optional) User ID of the point of contact for the project. Pass null to unset. |
|
|
(Optional) Main file format specified by its API Extension name. Used for locale downloads if no format is specified. For API Extension names of available file formats see Format Guide or our Formats API Endpoint. |
|
|
(Optional) Main technology stack used in the project. It affects for example the suggested placeholder style. Predefined values include: Ruby, JavaScript, AngularJS, React, iOS, Android, Python, PHP, Java, Go, Windows Phone, Rails, Node.js, .NET, Django, Symfony, Yii Framework, Zend Framework, Apple App Store Description, Google Play Description, but it can also take any other value. |
|
|
(Optional) Indicates whether the project should share the account's translation memory |
|
|
(Optional) Image to identify the project |
|
|
(Optional) Indicates whether the project image should be deleted. |
|
|
(Optional) Review Workflow. "simple" / "review". Read more |
|
|
(Optional) Enable machine translation support in the project. Required for Pre-Translation |
|
|
(Optional) Enable branching in the project |
|
|
(Optional) Protect the master branch in project where branching is enabled |
|
|
(Optional) Otherwise, translators are not allowed to edit translations other than strings |
|
|
(Optional) We can validate and highlight your ICU messages. Read more |
|
|
(Optional) Displays the input fields for the 'ZERO' plural form for every key as well although only some languages require the 'ZERO' explicitly. |
|
|
(Optional) Autopilot, requires machine_translation_enabled. Read more |
|
|
(Optional) Requires autotranslate_enabled to be true |
|
|
(Optional) Requires autotranslate_enabled to be true |
|
|
(Optional) Requires autotranslate_enabled to be true |
|
|
(Optional) Requires autotranslate_enabled to be true |
|
|
(Optional) Requires autotranslate_enabled to be true |
|
|
(Optional) Requires autotranslate_enabled to be true |
|
|
(Optional) Sets the default encoding for Uploads. If you leave it empty, we will try to guess it automatically for you when you Upload a file. You can still override this value by setting the file_encoding parameter for Uploads. |
Quality performance score
POST Get Translation Quality
/projects/{project_id}/quality_performance_score
Retrieves the quality scores for your Strings translations. Returns a score, measured by Phrase QPS
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Translation ids you want to get the quality performance score for |
Release Triggers (5)
POST Create a release trigger
/accounts/{account_id}/distributions/{distribution_id}/release_triggers
Create a new recurring release. New releases will be published automatically, based on the cron schedule provided. Currently, only one release trigger can exist per distribution.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Account ID |
|
|
Distribution ID |
|
|
N/A |
Options (7)
|
Option Name |
Description |
|---|---|
|
|
Cron schedule for the scheduler. Read more about the format of this field at https://en.wikipedia.org/wiki/Cron |
|
|
Time zone for the scheduler |
|
|
List of locale ids that will be included in the release. |
|
|
Only include tagged keys in the release. For a key to be included it must be tagged with all tags provided |
|
|
Branch used for release |
|
|
The created releases will be available only for apps with version greater or equal to this value |
|
|
The created releases will be available only for apps with version less or equal to this value |
DELETE Delete a single release trigger
/accounts/{account_id}/distributions/{distribution_id}/release_triggers/{id}
Delete a single release trigger.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Account ID |
|
|
Distribution ID |
|
|
ID |
|
|
N/A |
GET Get a single release trigger
/accounts/{account_id}/distributions/{distribution_id}/release_triggers/{id}
Get details of a single release trigger.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Account ID |
|
|
Distribution ID |
|
|
ID |
|
|
N/A |
GET List release triggers
/accounts/{account_id}/distributions/{distribution_id}/release_triggers
List all release triggers for the given distribution.
Note: Currently only one release trigger can exist per distribution.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Account ID |
|
|
Distribution ID |
|
|
N/A |
PATCH Update a release trigger
/accounts/{account_id}/distributions/{distribution_id}/release_triggers/{id}
Update a recurring release.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Account ID |
|
|
Distribution ID |
|
|
ID |
|
|
N/A |
Options (7)
|
Option Name |
Description |
|---|---|
|
|
Cron schedule for the scheduler. Read more about the format of this field at https://en.wikipedia.org/wiki/Cron |
|
|
Time zone for the scheduler |
|
|
List of locale ids that will be included in the release. |
|
|
Only include tagged keys in the release. For a key to be included it must be tagged with all tags provided |
|
|
Branch used for release |
|
|
The created releases will be available only for apps with version greater or equal to this value |
|
|
The created releases will be available only for apps with version less or equal to this value |
Releases (6)
POST Create a release
/accounts/{account_id}/distributions/{distribution_id}/releases
Create a new release.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Account ID |
|
|
Distribution ID |
|
|
N/A |
Options (7)
|
Option Name |
Description |
|---|---|
|
|
Description of the release |
|
|
List of platforms the release should support. |
|
|
List of locale ids that will be included in the release. If empty, distribution locales will be used |
|
|
Only include tagged keys in the release. For a key to be included it must be tagged with all tags provided |
|
|
Minimum version of the app that the release supports in semver format |
|
|
Maximum version of the app that the release supports in semver format |
|
|
Branch used for release |
DELETE Delete a release
/accounts/{account_id}/distributions/{distribution_id}/releases/{id}
Delete an existing release.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Account ID |
|
|
Distribution ID |
|
|
ID |
|
|
N/A |
GET Get a single release
/accounts/{account_id}/distributions/{distribution_id}/releases/{id}
Get details on a single release.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Account ID |
|
|
Distribution ID |
|
|
ID |
|
|
N/A |
GET List releases
/accounts/{account_id}/distributions/{distribution_id}/releases
List all releases for the given distribution.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Account ID |
|
|
Distribution ID |
|
|
Page number |
|
|
Limit on the number of objects to be returned, between 1 and 100. 25 by default |
|
|
N/A |
POST Publish a release
/accounts/{account_id}/distributions/{distribution_id}/releases/{id}/publish
Publish a release for production.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Account ID |
|
|
Distribution ID |
|
|
ID |
|
|
N/A |
PATCH Update a release
/accounts/{account_id}/distributions/{distribution_id}/releases/{id}
Update an existing release.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Account ID |
|
|
Distribution ID |
|
|
ID |
|
|
N/A |
Options (5)
|
Option Name |
Description |
|---|---|
|
|
Description of the release |
|
|
List of platforms the release should support. |
|
|
Minimum version of the app that the release supports in semver format |
|
|
Maximum version of the app that the release supports in semver format |
|
|
Branch used for release |
Repo Sync Events (2)
GET Get a single Repo Sync Event
/accounts/{account_id}/repo_syncs/{repo_sync_id}/events/{id}
Shows a single Repo Sync event.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Account ID |
|
|
Repo Sync ID |
|
|
ID |
|
|
N/A |
GET Repository Syncs History
/accounts/{account_id}/repo_syncs/{id}/events
Get the history of a single Repo Sync. The history includes all imports and exports
performed by the Repo Sync.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Account ID |
|
|
ID |
|
|
N/A |
Repo Syncs (6)
POST Activate a Repo Sync
/accounts/{account_id}/repo_syncs/{id}/activate
Activate a deactivated Repo Sync. Active syncs can be used to import and export translations,
and imports to Phrase are automatically triggered by pushes to the repository, if configured.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Account ID |
|
|
ID |
|
|
N/A |
POST Deactivate a Repo Sync
/accounts/{account_id}/repo_syncs/{id}/deactivate
Deactivate an active Repo Sync. Import and export can't be performed on deactivated syncs
and the pushes to the repository won't trigger the import to Phrase.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Account ID |
|
|
ID |
|
|
N/A |
POST Export to code repository
/accounts/{account_id}/repo_syncs/{id}/export
Export translations from Phrase Strings to repository provider according to the
.phrase.yml file within the code repository.
Export is done asynchronously and may take several seconds depending on the project size.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Account ID |
|
|
ID |
|
|
N/A |
GET Get Repo Syncs
/accounts/{account_id}/repo_syncs
Lists all Repo Syncs from an account
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Account ID |
|
|
N/A |
GET Get a single Repo Sync
/accounts/{account_id}/repo_syncs/{id}
Shows a single Repo Sync setting.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Account ID |
|
|
ID |
|
|
N/A |
POST Import from code repository
/accounts/{account_id}/repo_syncs/{id}/import
Import translations from repository provider to Phrase Strings according to the .phrase.yml file
within the code repository.
_Import is done asynchronously and may take several seconds depending on the project size._
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Account ID |
|
|
ID |
|
|
N/A |
Reports (2)
GET Get Project Report
/projects/{project_id}/report
Get report of a single project.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
specify the branch to use |
|
|
N/A |
GET List Locale Reports
/projects/{project_id}/report/locales
List all locale reports for the given project
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
Page number |
|
|
Limit on the number of objects to be returned, between 1 and 100. 25 by default |
|
|
Locale Code |
|
|
tag |
|
|
specify the branch to use |
|
|
N/A |
Screenshot Markers (5)
POST Create a screenshot marker
/projects/{project_id}/screenshots/{screenshot_id}/markers
Create a new screenshot marker.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
Screenshot ID |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
specify the branch to use |
|
|
Specify the Key ID which should be highlighted on the specified screenshot. The Key must belong to the project. |
|
|
Presentation details of the screenshot marker in JSON format. Each Screenshot Marker is represented as a rectangular shaped highlight box with the name of the specified Key attached. You can specify the marker position on the screenshot (x-axis and y-axis in pixels) from the top left corner of the screenshot and the dimensions of the marker itself (w and h in pixels). |
DELETE Delete a screenshot marker
/projects/{project_id}/screenshots/{screenshot_id}/markers
Delete an existing screenshot marker.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
Screenshot ID |
|
|
specify the branch to use |
|
|
N/A |
GET Get a single screenshot marker
/projects/{project_id}/screenshots/{screenshot_id}/markers/{id}
Get details on a single screenshot marker for a given project.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
Screenshot ID |
|
|
ID |
|
|
specify the branch to use |
|
|
N/A |
GET List screenshot markers
/projects/{project_id}/screenshots/{id}/markers
List all screenshot markers for the given project.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
ID |
|
|
Page number |
|
|
Limit on the number of objects to be returned, between 1 and 100. 25 by default |
|
|
specify the branch to use |
|
|
N/A |
PATCH Update a screenshot marker
/projects/{project_id}/screenshots/{screenshot_id}/markers
Update an existing screenshot marker.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
Screenshot ID |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
specify the branch to use |
|
|
Specify the Key ID which should be highlighted on the specified screenshot. The Key must belong to the project. |
|
|
Presentation details of the screenshot marker in JSON format. Each Screenshot Marker is represented as a rectangular shaped highlight box with the name of the specified Key attached. You can specify the marker position on the screenshot (x-axis and y-axis in pixels) from the top left corner of the screenshot and the dimensions of the marker itself (w and h in pixels). |
Screenshots (5)
POST Create a screenshot
/projects/{project_id}/screenshots
Create a new screenshot.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
N/A |
Options (4)
|
Option Name |
Description |
|---|---|
|
|
specify the branch to use |
|
|
Name of the screenshot |
|
|
Description of the screenshot |
|
|
Screenshot file |
DELETE Delete a screenshot
/projects/{project_id}/screenshots/{id}
Delete an existing screenshot.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
ID |
|
|
specify the branch to use |
|
|
N/A |
GET Get a single screenshot
/projects/{project_id}/screenshots/{id}
Get details on a single screenshot for a given project.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
ID |
|
|
specify the branch to use |
|
|
N/A |
GET List screenshots
/projects/{project_id}/screenshots
List all screenshots for the given project.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
Page number |
|
|
Limit on the number of objects to be returned, between 1 and 100. 25 by default |
|
|
specify the branch to use |
|
|
filter by key |
|
|
N/A |
PATCH Update a screenshot
/projects/{project_id}/screenshots/{id}
Update an existing screenshot.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
ID |
|
|
N/A |
Options (4)
|
Option Name |
Description |
|---|---|
|
|
specify the branch to use |
|
|
Name of the screenshot |
|
|
Description of the screenshot |
|
|
Screenshot file |
Search
POST Search across projects
/accounts/{account_id}/search
Search for keys and translations in all account projects
Note: Search is limited to 10000 results and may not include recently updated data depending on the project sizes.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Account ID |
|
|
N/A |
Options (4)
|
Option Name |
Description |
|---|---|
|
|
Search query |
|
|
Locale code |
|
|
Page |
|
|
Number of results per page |
Spaces (8)
POST Add Project to Space
/accounts/{account_id}/spaces/{space_id}/projects
Adds an existing project to the space.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Account ID |
|
|
Space ID |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Project ID to add or to the Space |
POST Create a Space
/accounts/{account_id}/spaces
Create a new Space.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Account ID |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Name of the space |
DELETE Delete Space
/accounts/{account_id}/spaces/{id}
Delete the specified Space.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Account ID |
|
|
ID |
|
|
N/A |
GET Get Space
/accounts/{account_id}/spaces/{id}
Show the specified Space.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Account ID |
|
|
ID |
|
|
N/A |
GET List Projects in Space
/accounts/{account_id}/spaces/{space_id}/projects
List all projects for the specified Space.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Account ID |
|
|
Space ID |
|
|
Page number |
|
|
Limit on the number of objects to be returned, between 1 and 100. 25 by default |
|
|
N/A |
GET List Spaces
/accounts/{account_id}/spaces
List all Spaces for the given account.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Account ID |
|
|
Page number |
|
|
Limit on the number of objects to be returned, between 1 and 100. 25 by default |
|
|
N/A |
DELETE Remove Project from Space
/accounts/{account_id}/spaces/{space_id}/projects/{id}
Removes a specified project from the specified space.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Account ID |
|
|
Space ID |
|
|
ID |
|
|
N/A |
PATCH Update Space
/accounts/{account_id}/spaces/{id}
Update the specified Space.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Account ID |
|
|
ID |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
New name of the space |
Style guides (5)
POST Create a style guide
/projects/{project_id}/styleguides
Create a new style guide.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
N/A |
Options (13)
|
Option Name |
Description |
|---|---|
|
|
Style guide title |
|
|
Audience description |
|
|
Can be one of: not_specified, children, teenager, young_adults, adults, old_adults. |
|
|
Can be one of: not_specified, first_person_singular, second_person_singular, third_person_singular_masculine, third_person_singular_feminine, third_person_singular_neuter, first_person_plural, second_person_plural, third_person_plural. |
|
|
Can be one of: not_specified, popular, technical, fictional. |
|
|
Description of the business |
|
|
Company branding to remain consistent. |
|
|
Formatting requirements and character limitations. |
|
|
List of terms and/or phrases that need to be translated consistently. |
|
|
Formal or informal pronouns, consistent conjugation, grammatical gender |
|
|
Can be one of: Cultural/Conversational, Literal, Neutral. |
|
|
Tone requirement descriptions |
|
|
Provide links to sample product pages, FAQ pages, etc. to give the translator a point of reference. You can also provide past translations. Even snippets or short paragraphs are helpful for maintaining consistency. |
DELETE Delete a style guide
/projects/{project_id}/styleguides/{id}
Delete an existing style guide.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
ID |
|
|
N/A |
GET Get a single style guide
/projects/{project_id}/styleguides/{id}
Get details on a single style guide.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
ID |
|
|
N/A |
GET List style guides
/projects/{project_id}/styleguides
List all styleguides for the given project.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
Page number |
|
|
Limit on the number of objects to be returned, between 1 and 100. 25 by default |
|
|
N/A |
PATCH Update a style guide
/projects/{project_id}/styleguides/{id}
Update an existing style guide.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
ID |
|
|
N/A |
Options (13)
|
Option Name |
Description |
|---|---|
|
|
Style guide title |
|
|
Audience description |
|
|
Can be one of: not_specified, children, teenager, young_adults, adults, old_adults. |
|
|
Can be one of: not_specified, first_person_singular, second_person_singular, third_person_singular_masculine, third_person_singular_feminine, third_person_singular_neuter, first_person_plural, second_person_plural, third_person_plural. |
|
|
Can be one of: not_specified, popular, technical, fictional. |
|
|
Description of the business |
|
|
Company branding to remain consistent. |
|
|
Formatting requirements and character limitations. |
|
|
List of terms and/or phrases that need to be translated consistently. |
|
|
Formal or informal pronouns, consistent conjugation, grammatical gender |
|
|
Can be one of: Cultural/Conversational, Literal, Neutral. |
|
|
Tone requirement descriptions |
|
|
Provide links to sample product pages, FAQ pages, etc. to give the translator a point of reference. You can also provide past translations. Even snippets or short paragraphs are helpful for maintaining consistency. |
Tags (4)
POST Create a tag
/projects/{project_id}/tags
Create a new tag.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
specify the branch to use |
|
|
Name of the tag |
DELETE Delete a tag
/projects/{project_id}/tags/{name}
Delete an existing tag.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
name |
|
|
specify the branch to use |
|
|
N/A |
GET Get a single tag
/projects/{project_id}/tags/{name}
Get details and progress information on a single tag for a given project.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
name |
|
|
omit statistics in the response |
|
|
specify the branch to use |
|
|
N/A |
GET List tags
/projects/{project_id}/tags
List all tags for the given project.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
Page number |
|
|
Limit on the number of objects to be returned, between 1 and 100. 25 by default |
|
|
excludes tags generated by the system, e.g. job, upload or figma tags |
|
|
specify the branch to use |
|
|
N/A |
Teams (11)
POST Add Project to Team
/accounts/{account_id}/teams/{team_id}/projects
Adds an existing project to the team.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Account ID |
|
|
Team ID |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Project ID to add to the Team |
POST Add Space
/accounts/{account_id}/teams/{team_id}/spaces
Adds an existing space to the team.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Account ID |
|
|
Team ID |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Space ID to add to the Team |
POST Add User
/accounts/{account_id}/teams/{team_id}/users
Adds an existing user to the team.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Account ID |
|
|
Team ID |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
User ID to add to the Team |
POST Create a Team
/accounts/{account_id}/teams
Create a new Team.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Account ID |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Name of the team |
DELETE Delete Team
/accounts/{account_id}/teams/{id}
Delete the specified Team.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Account ID |
|
|
ID |
|
|
N/A |
GET Get Team
/accounts/{account_id}/teams/{id}
Show the specified Team.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Account ID |
|
|
ID |
|
|
N/A |
GET List Teams
/accounts/{account_id}/teams
List all Teams for the given account.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Account ID |
|
|
Page number |
|
|
Limit on the number of objects to be returned, between 1 and 100. 25 by default |
|
|
N/A |
DELETE Remove Project from Team
/accounts/{account_id}/teams/{team_id}/projects/{id}
Removes a specified project from the specified team.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Account ID |
|
|
Team ID |
|
|
ID |
|
|
N/A |
DELETE Remove Space
/accounts/{account_id}/teams/{team_id}/spaces/{id}
Removes a specified space from the specified team.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Account ID |
|
|
Team ID |
|
|
ID |
|
|
N/A |
DELETE Remove User
/accounts/{account_id}/teams/{team_id}/users/{id}
Removes a specified user from the specified team.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Account ID |
|
|
Team ID |
|
|
ID |
|
|
N/A |
PATCH Update Team
/accounts/{account_id}/teams/{id}
Update the specified Team.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Account ID |
|
|
ID |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
New name of the team |
Translations (19)
POST Create a translation
/projects/{project_id}/translations
Create a translation.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
N/A |
Options (8)
|
Option Name |
Description |
|---|---|
|
|
specify the branch to use |
|
|
Locale. Can be the name or id of the locale. Preferred is id |
|
|
Key |
|
|
Translation content |
|
|
Plural suffix. Can be one of: zero, one, two, few, many, other. Must be specified if the key associated to the translation is pluralized. |
|
|
Indicates whether translation is unverified. Part of the Advanced Workflows feature. |
|
|
Indicates whether translation is excluded. |
|
|
Indicates whether the translation should be auto-translated. Responses with status 422 if provided for translation within a non-default locale or the project does not have the Autopilot feature enabled. |
PATCH Exclude a translation from export
/projects/{project_id}/translations/{id}/exclude
Set exclude from export flag on an existing translation.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
ID |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
specify the branch to use |
PATCH Exclude translations by query
/projects/{project_id}/translations/exclude
Exclude translations matching query from locale export.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
N/A |
Options (4)
|
Option Name |
Description |
|---|---|
|
|
specify the branch to use |
|
|
Specify a query to find translations by content (including wildcards). Note: Search is limited to 10000 results and may not include recently updated data (depending on the project size). The following qualifiers are supported in the query: id:translation_id,... for queries on a comma-separated list of ids
Find more examples here. |
|
|
Sort criteria. Can be one of: key_name, created_at, updated_at. |
|
|
Order direction. Can be one of: asc, desc. |
GET Get a single translation
/projects/{project_id}/translations/{id}
Get details on a single translation.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
ID |
|
|
specify the branch to use |
|
|
N/A |
PATCH Include a translation
/projects/{project_id}/translations/{id}/include
Remove exclude from export flag from an existing translation.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
ID |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
specify the branch to use |
PATCH Include translations by query
/projects/{project_id}/translations/include
Include translations matching query in locale export.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
N/A |
Options (4)
|
Option Name |
Description |
|---|---|
|
|
specify the branch to use |
|
|
Specify a query to find translations by content (including wildcards). Note: Search is limited to 10000 results and may not include recently updated data (depending on the project size). The following qualifiers are supported in the query:
Find more examples here. |
|
|
Sort criteria. Can be one of: key_name, created_at, updated_at. |
|
|
Order direction. Can be one of: asc, desc. |
GET List all translations
/projects/{project_id}/translations
List translations for the given project. If you want to download all translations for one locale we recommend to use the locales#download endpoint.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Last modified condition, see Conditional GET requests / HTTP Caching (optional) |
|
|
ETag condition, see Conditional GET requests / HTTP Caching (optional) |
|
|
Project ID |
|
|
Page number |
|
|
Limit on the number of objects to be returned, between 1 and 100. 25 by default |
|
|
specify the branch to use |
|
|
Sort criteria. Can be one of: key_name, created_at, updated_at. |
|
|
Order direction. Can be one of: asc, desc. |
|
|
Specify a query to find translations by content (including wildcards). Note: Search is limited to 10000 results and may not include recently updated data (depending on the project size). The following qualifiers are supported in the query: id:translation_id,... for queries on a comma-separated list of ids
Find more examples here. |
|
|
N/A |
GET List translations by key
/projects/{project_id}/keys/{key_id}/translations
List translations for a specific key.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
Translation Key ID |
|
|
Page number |
|
|
Limit on the number of objects to be returned, between 1 and 100. 25 by default |
|
|
specify the branch to use |
|
|
Sort criteria. Can be one of: key_name, created_at, updated_at. |
|
|
Order direction. Can be one of: asc, desc. |
|
|
Specify a query to find translations by content (including wildcards). The following qualifiers are supported in the query: id:translation_id,... for queries on a comma-separated list of ids
Find more examples here. |
|
|
N/A |
GET List translations by locale
/projects/{project_id}/locales/{locale_id}/translations
List translations for a specific locale. If you want to download all translations for one locale we recommend to use the locales#download endpoint.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
Locale ID |
|
|
Page number |
|
|
Limit on the number of objects to be returned, between 1 and 100. 25 by default |
|
|
specify the branch to use |
|
|
Sort criteria. Can be one of: key_name, created_at, updated_at. |
|
|
Order direction. Can be one of: asc, desc. |
|
|
Specify a query to find translations by content (including wildcards). Note: Search is limited to 10000 results and may not include recently updated data (depending on the project size). The following qualifiers are supported in the query:
Find more examples here. |
|
|
N/A |
PATCH Mark a translation as unverified
/projects/{project_id}/translations/{id}/unverify
Mark an existing translation as unverified.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
ID |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
specify the branch to use |
PATCH Review a translation
/projects/{project_id}/translations/{id}/review
Mark an existing translation as reviewed.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
ID |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
specify the branch to use |
PATCH Review translations selected by query
/projects/{project_id}/translations/review
Review translations matching query.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
specify the branch to use |
|
|
Specify a query to find translations by content (including wildcards). Note: Search is limited to 10000 results and may not include recently updated data (depending on the project size). The following qualifiers are supported in the query: id:translation_id,... for queries on a comma-separated list of ids
Find more examples here. |
POST Search translations
/projects/{project_id}/translations/search
Search translations for the given project. Provides the same search interface as translations#index but allows POST requests to avoid limitations imposed by GET requests. If you want to download all translations for one locale we recommend to use the locales#download endpoint.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
Page number |
|
|
Limit on the number of objects to be returned, between 1 and 100. 25 by default |
|
|
N/A |
Options (4)
|
Option Name |
Description |
|---|---|
|
|
specify the branch to use |
|
|
Sort criteria. Can be one of: key_name, created_at, updated_at. |
|
|
Order direction. Can be one of: asc, desc. |
|
|
Specify a query to find translations by content (including wildcards). Note: Search is limited to 10000 results and may not include recently updated data (depending on the project size). The following qualifiers are supported in the query:
Find more examples here. |
PATCH Unreview a translation
/projects/{project_id}/translations/{id}/unreview
Mark a reviewed translation as translated.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
ID |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
specify the branch to use |
PATCH Unreview translations selected by query
/projects/{project_id}/translations/unreview
Unreview translations matching query.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
specify the branch to use |
|
|
Specify a query to find translations by content (including wildcards). Note: Search is limited to 10000 results and may not include recently updated data (depending on the project size). The following qualifiers are supported in the query:
Find more examples here. |
PATCH Unverify translations by query
/projects/{project_id}/translations/unverify
Mark translations matching query as unverified.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
N/A |
Options (4)
|
Option Name |
Description |
|---|---|
|
|
specify the branch to use |
|
|
Specify a query to find translations by content (including wildcards). Note: Search is limited to 10000 results and may not include recently updated data (depending on the project size). The following qualifiers are supported in the query:
Find more examples here. |
|
|
Sort criteria. Can be one of: key_name, created_at, updated_at. |
|
|
Order direction. Can be one of: asc, desc. |
PATCH Update a translation
/projects/{project_id}/translations/{id}
Update an existing translation.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
ID |
|
|
N/A |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
specify the branch to use |
|
|
Translation content |
|
|
Plural suffix. Can be one of: zero, one, two, few, many, other. Must be specified if the key associated to the translation is pluralized. |
|
|
Indicates whether translation is unverified. Part of the Advanced Workflows feature. |
|
|
Indicates whether translation is excluded. |
|
|
Indicates whether the translation should be auto-translated. Responses with status 422 if provided for translation within a non-default locale or the project does not have the Autopilot feature enabled. |
PATCH Verify a translation
/projects/{project_id}/translations/{id}/verify
Verify an existing translation.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
ID |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
specify the branch to use |
PATCH Verify translations by query
/projects/{project_id}/translations/verify
Verify translations matching query.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
specify the branch to use |
|
|
specify the locale of the translations to be verified |
|
|
Specify a query to find translations by content (including wildcards). Note: Search is limited to 10000 results and may not include recently updated data (depending on the project size). The following qualifiers are supported in the query:
Find more examples here. |
Uploads (3)
GET Get a single upload
/projects/{project_id}/uploads/{id}
View details and summary for a single upload.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
ID |
|
|
specify the branch to use |
|
|
N/A |
GET List uploads
/projects/{project_id}/uploads
List all uploads for the given project.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
Page number |
|
|
Limit on the number of objects to be returned, between 1 and 100. 25 by default |
|
|
specify the branch to use |
|
|
N/A |
POST Upload a new file
/projects/{project_id}/uploads
Upload a new language file. Creates necessary resources in your project.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
N/A |
Options (21)
|
Option Name |
Description |
|---|---|
|
|
specify the branch to use |
|
|
File to be imported |
|
|
File format. Auto-detected when possible and not specified. |
|
|
Locale of the file's content. Can be the name or id of the locale. Preferred is id. |
|
|
List of tags separated by comma to be associated with the new keys contained in the upload. |
|
|
Indicates whether existing translations should be updated with the file content. |
|
|
Indicates whether existing custom metadata properties should be updated with the file content |
|
|
Pass false here to prevent new keys from being created and existing keys updated. |
|
|
Update target translations only if the source translations of the uploaded multilingual file match the stored translations. |
|
|
Existing key descriptions will be updated with the file content. Empty descriptions overwrite existing descriptions. |
|
|
This option is obsolete. Providing the option will cause a bad request error. |
|
|
Indicates whether the upload should not create upload tags. |
|
|
Indicates whether the upload should unverify updated translations. |
|
|
Enforces a specific encoding on the file contents. Valid options are "UTF-8", "UTF-16" and "ISO-8859-1". |
|
|
Mapping between locale names and translation columns. Required in some formats like CSV or XLSX. |
|
|
Additional options available for specific formats. See our format guide for the complete list. |
|
|
If set, translations for the uploaded language will be fetched automatically. |
|
|
Indicates whether all translations mentioned in the upload should be verified. |
|
|
Indicated whether the imported translations should be marked as reviewed. This setting is available if the review workflow is enabled for the project. |
|
|
Indicates whether only keys affected (created or updated) by the upload should be tagged. The default is false |
|
|
This prefix will be added to all uploaded translation key names to prevent collisions. Use a meaningful prefix related to your project or file to keep key names organized. |
Users
GET Show current User
/user
Show details for current User.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
N/A |
Variables (5)
POST Create a variable
/projects/{project_id}/variables
Create a new variable.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
Name of the variable |
|
|
Value of the variable |
DELETE Delete a variable
/projects/{project_id}/variables/{name}
Delete an existing variable.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
name |
|
|
N/A |
GET Get a single variable
/projects/{project_id}/variables/{name}
Get details on a single variable for a given project.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
name |
|
|
N/A |
GET List variables
/projects/{project_id}/variables
List all variables for the current project.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
Page number |
|
|
Limit on the number of objects to be returned, between 1 and 100. 25 by default |
|
|
N/A |
PATCH Update a variable
/projects/{project_id}/variables/{name}
Update an existing variable.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
name |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
Name of the variable |
|
|
Value of the variable |
Versions / History (2)
GET Get a single version
/projects/{project_id}/translations/{translation_id}/versions/{id}
Get details on a single version.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
Translation ID |
|
|
ID |
|
|
specify the branch to use |
|
|
N/A |
GET List all versions
/projects/{project_id}/translations/{translation_id}/versions
List all changes done to a given translation.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
Translation ID |
|
|
Page number |
|
|
Limit on the number of objects to be returned, between 1 and 100. 25 by default |
|
|
specify the branch to use |
|
|
N/A |
Webhook Deliveries (3)
GET Get a single webhook delivery
/projects/{project_id}/webhooks/{webhook_id}/deliveries/{id}
Get all information about a single webhook delivery for the given ID.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
Webhook ID |
|
|
ID |
|
|
N/A |
GET List webhook deliveries
/projects/{project_id}/webhooks/{webhook_id}/deliveries
List all webhook deliveries for the given webhook_id.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
Webhook ID |
|
|
List of Response Status Codes |
|
|
N/A |
POST Redeliver a single webhook delivery
/projects/{project_id}/webhooks/{webhook_id}/deliveries/{id}/redeliver
Trigger an individual webhook delivery to be redelivered.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
Webhook ID |
|
|
ID |
|
|
N/A |
Webhooks (6)
POST Create a webhook
/projects/{project_id}/webhooks
Create a new webhook.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
N/A |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
Callback URL to send requests to |
|
|
Webhook secret used to calculate signature. If empty, the default project secret will be used. |
|
|
Webhook description |
|
|
List of event names to trigger the webhook (separated by comma) |
|
|
Whether webhook is active or inactive |
|
|
If enabled, webhook will also be triggered for events from branches of the project specified. |
DELETE Delete a webhook
/projects/{project_id}/webhooks/{id}
Delete an existing webhook.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
ID |
|
|
N/A |
GET Get a single webhook
/projects/{project_id}/webhooks/{id}
Get details on a single webhook.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
ID |
|
|
N/A |
GET List webhooks
/projects/{project_id}/webhooks
List all webhooks for the given project.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
Page number |
|
|
Limit on the number of objects to be returned, between 1 and 100. 25 by default |
|
|
N/A |
POST Test a webhook
/projects/{project_id}/webhooks/{id}/test
Perform a test request for a webhook.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
ID |
|
|
N/A |
PATCH Update a webhook
/projects/{project_id}/webhooks/{id}
Update an existing webhook.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Two-Factor-Authentication token (optional) |
|
|
Project ID |
|
|
ID |
|
|
N/A |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
Callback URL to send requests to |
|
|
Webhook secret used to calculate signature. If empty, the default project secret will be used. |
|
|
Webhook description |
|
|
List of event names to trigger the webhook (separated by comma) |
|
|
Whether webhook is active or inactive |
|
|
If enabled, webhook will also be triggered for events from branches of the project specified. |