# Phrase Developer Hub: English API Reference Strings ## Strings ### - [Introduction](https://developers.phrase.com/en/api/strings/introduction.md) ### Overview - [Getting started](https://developers.phrase.com/en/api/strings/getting-started.md) - [Authentication](https://developers.phrase.com/en/api/strings/authentication.md) - [Pagination](https://developers.phrase.com/en/api/strings/pagination.md) - [Usage examples](https://developers.phrase.com/en/api/strings/usage-examples.md): Learn how to filter translations and keys, verify translations in bulk, manage tags, and upload Excel files using the Phrase Strings API v2. ### API Documentation #### Accounts - [List accounts](https://developers.phrase.com/en/api/strings/accounts/list-accounts.md): List all accounts the current user has access to. - [Get a single account](https://developers.phrase.com/en/api/strings/accounts/get-a-single-account.md): Get details on a single account. #### Authorizations - [List authorizations](https://developers.phrase.com/en/api/strings/authorizations/list-authorizations.md): List all your authorizations. - [Create an authorization](https://developers.phrase.com/en/api/strings/authorizations/create-an-authorization.md): Create a new authorization. - [Get a single authorization](https://developers.phrase.com/en/api/strings/authorizations/get-a-single-authorization.md): Get details on a single authorization. - [Delete an authorization](https://developers.phrase.com/en/api/strings/authorizations/delete-an-authorization.md): Delete an existing authorization. API calls using that token will stop working. - [Update an authorization](https://developers.phrase.com/en/api/strings/authorizations/update-an-authorization.md): Update an existing authorization. #### Automation Events - [List events for an automation](https://developers.phrase.com/en/api/strings/automation-events/list-events-for-an-automation.md): Returns the run history for a specific automation, newest-first. - [List automation events for an account](https://developers.phrase.com/en/api/strings/automation-events/list-automation-events-for-an-account.md): Returns the run history across all automations in the account, newest-first. #### Automations - [List automations](https://developers.phrase.com/en/api/strings/automations/list-automations.md): List all automations for an account. - [Create an automation](https://developers.phrase.com/en/api/strings/automations/create-an-automation.md): Create a new automation. - [Get a single automation](https://developers.phrase.com/en/api/strings/automations/get-a-single-automation.md): Get details of a single automation. - [Destroy automation](https://developers.phrase.com/en/api/strings/automations/destroy-automation.md): Destroy an automation of an account. - [Update an automation](https://developers.phrase.com/en/api/strings/automations/update-an-automation.md): Update an existing automation. - [Activate an automation](https://developers.phrase.com/en/api/strings/automations/activate-an-automation.md): Activate an automation. - [Deactivate an automation](https://developers.phrase.com/en/api/strings/automations/deactivate-an-automation.md): Deactivate an automation. - [Trigger an automation](https://developers.phrase.com/en/api/strings/automations/trigger-an-automation.md): Trigger an automation. #### Blacklisted Keys - [List blocked keys](https://developers.phrase.com/en/api/strings/blacklisted-keys/list-blocked-keys.md): List all rules for blocking keys for the given project. - [Create a blocked key](https://developers.phrase.com/en/api/strings/blacklisted-keys/create-a-blocked-key.md): Create a new rule for blocking keys. - [Get a single blocked key](https://developers.phrase.com/en/api/strings/blacklisted-keys/get-a-single-blocked-key.md): Get details on a single rule for blocking keys for a given project. - [Delete a blocked key](https://developers.phrase.com/en/api/strings/blacklisted-keys/delete-a-blocked-key.md): Delete an existing rule for blocking keys. - [Update a blocked key](https://developers.phrase.com/en/api/strings/blacklisted-keys/update-a-blocked-key.md): Update an existing rule for blocking keys. #### Branches - [List branches](https://developers.phrase.com/en/api/strings/branches/list-branches.md): List all branches of the current project. - [Create a branch](https://developers.phrase.com/en/api/strings/branches/create-a-branch.md): Create a new branch. - [Get a single branch](https://developers.phrase.com/en/api/strings/branches/get-a-single-branch.md): Get details on a single branch for a given project. - [Delete a branch](https://developers.phrase.com/en/api/strings/branches/delete-a-branch.md): Delete an existing branch. - [Update a branch](https://developers.phrase.com/en/api/strings/branches/update-a-branch.md): Update an existing branch. Only the branch name can be changed. - [Merge a branch](https://developers.phrase.com/en/api/strings/branches/merge-a-branch.md): Merge an existing branch back into its base branch. - [Sync a branch](https://developers.phrase.com/en/api/strings/branches/sync-a-branch.md): Pull changes from the base branch into this branch, applying the chosen conflict-resolution strategy. - [Compare branches](https://developers.phrase.com/en/api/strings/branches/compare-branches.md): Compare branch with main branch. - [Create comparison (async.)](https://developers.phrase.com/en/api/strings/branches/create-comparison-async.md): Create a branch comparison asynchronously. #### Checks - [List check issues](https://developers.phrase.com/en/api/strings/checks/list-check-issues.md): **Note:** The Checks API is still in development and might change in subsequent releases. - [Dismiss a check issue](https://developers.phrase.com/en/api/strings/checks/dismiss-a-check-issue.md): **Note:** The Checks API is still in development and might change in subsequent releases. #### Comment Reactions - [List reactions](https://developers.phrase.com/en/api/strings/comment-reactions/list-reactions.md): List all reactions for a comment. - [Create a reaction](https://developers.phrase.com/en/api/strings/comment-reactions/create-a-reaction.md): Create a new reaction for a comment. - [Get a single reaction](https://developers.phrase.com/en/api/strings/comment-reactions/get-a-single-reaction.md): Get details on a single reaction. - [Delete a reaction](https://developers.phrase.com/en/api/strings/comment-reactions/delete-a-reaction.md): Delete an existing reaction. #### Comment Replies - [List replies](https://developers.phrase.com/en/api/strings/comment-replies/list-replies.md): List all replies for a comment. - [Create a reply](https://developers.phrase.com/en/api/strings/comment-replies/create-a-reply.md): Create a new reply for a comment. - [Get a single reply](https://developers.phrase.com/en/api/strings/comment-replies/get-a-single-reply.md): Get details on a single reply. - [Delete a reply](https://developers.phrase.com/en/api/strings/comment-replies/delete-a-reply.md): Delete an existing reply. - [Mark a reply as read](https://developers.phrase.com/en/api/strings/comment-replies/mark-a-reply-as-read.md): Mark a reply as read. - [Mark a reply as unread](https://developers.phrase.com/en/api/strings/comment-replies/mark-a-reply-as-unread.md): Mark a reply as unread. #### Comments - [List comments](https://developers.phrase.com/en/api/strings/comments/list-comments.md): List all comments for a key. - [Create a comment](https://developers.phrase.com/en/api/strings/comments/create-a-comment.md): Create a new comment for a key. - [Get a single comment](https://developers.phrase.com/en/api/strings/comments/get-a-single-comment.md): Get details on a single comment. - [Delete a comment](https://developers.phrase.com/en/api/strings/comments/delete-a-comment.md): Delete an existing comment. - [Update a comment](https://developers.phrase.com/en/api/strings/comments/update-a-comment.md): Update an existing comment. - [Check if comment is read](https://developers.phrase.com/en/api/strings/comments/check-if-comment-is-read.md): Check if comment was marked as read. Returns 204 if read, 404 if unread. - [Mark a comment as unread](https://developers.phrase.com/en/api/strings/comments/mark-a-comment-as-unread.md): Mark a comment as unread. - [Mark a comment as read](https://developers.phrase.com/en/api/strings/comments/mark-a-comment-as-read.md): Mark a comment as read. #### Custom Metadata - [List properties](https://developers.phrase.com/en/api/strings/custom-metadata/list-properties.md): List all custom metadata properties for an account. - [Create a property](https://developers.phrase.com/en/api/strings/custom-metadata/create-a-property.md): Create a new custom metadata property. - [Get a single property](https://developers.phrase.com/en/api/strings/custom-metadata/get-a-single-property.md): Get details of a single custom property. - [Destroy property](https://developers.phrase.com/en/api/strings/custom-metadata/destroy-property.md): Destroy a custom metadata property of an account. - [Update a property](https://developers.phrase.com/en/api/strings/custom-metadata/update-a-property.md): Update an existing custom metadata property. #### Distributions - [List distributions](https://developers.phrase.com/en/api/strings/distributions/list-distributions.md): List all distributions for the given account. - [Create a distribution](https://developers.phrase.com/en/api/strings/distributions/create-a-distribution.md): Create a new distribution. - [Get a single distribution](https://developers.phrase.com/en/api/strings/distributions/get-a-single-distribution.md): Get details on a single distribution. - [Delete a distribution](https://developers.phrase.com/en/api/strings/distributions/delete-a-distribution.md): Delete an existing distribution. - [Update a distribution](https://developers.phrase.com/en/api/strings/distributions/update-a-distribution.md): Update an existing distribution. #### Documents - [List documents](https://developers.phrase.com/en/api/strings/documents/list-documents.md): Returns all documents in a project that the authenticated user has read access to. A Document is a source file — an HTML or DOCX file — that has been uploaded to Phrase Strings and whose content is segmented into translation keys for localization. - [Delete document](https://developers.phrase.com/en/api/strings/documents/delete-document.md): Permanently deletes a document and all of its associated translation segments from the project. Use this when you want to remove a document that is no longer needed; the deletion cannot be reversed and all associated segments will be lost. #### Figma attachments - [List Figma attachments](https://developers.phrase.com/en/api/strings/figma-attachments/list-figma-attachments.md): List all Figma attachments for the given project - [Create a Figma attachment](https://developers.phrase.com/en/api/strings/figma-attachments/create-a-figma-attachment.md): Create a new Figma attachment. - [Get a single Figma attachment](https://developers.phrase.com/en/api/strings/figma-attachments/get-a-single-figma-attachment.md): Get details on a single Figma attachment for a given project. - [Delete a Figma attachment](https://developers.phrase.com/en/api/strings/figma-attachments/delete-a-figma-attachment.md): Delete an existing Figma attachment. - [Update a Figma attachment](https://developers.phrase.com/en/api/strings/figma-attachments/update-a-figma-attachment.md): Update an existing Figma attachment. #### Formats - [List formats](https://developers.phrase.com/en/api/strings/formats/list-formats.md): Returns all file formats that Phrase Strings supports. Use the api_name value from each format as the file_format parameter when uploading or downloading locale files. Not every format supports both directions: check the importable and exportable fields before using a format in a workflow. This endp… #### Glossaries - [List term bases](https://developers.phrase.com/en/api/strings/glossaries/list-term-bases.md): List all term bases (previously: glossaries) the current user has access to. - [Create a term base](https://developers.phrase.com/en/api/strings/glossaries/create-a-term-base.md): Create a new term base (previously: glossary). - [Get a single term base](https://developers.phrase.com/en/api/strings/glossaries/get-a-single-term-base.md): Get details on a single term base (previously: glossary). - [Delete a term base](https://developers.phrase.com/en/api/strings/glossaries/delete-a-term-base.md): Delete an existing term base (previously: glossary). - [Update a term base](https://developers.phrase.com/en/api/strings/glossaries/update-a-term-base.md): Update an existing term base (previously: glossary). #### Glossary Term Translations - [Create a translation for a term](https://developers.phrase.com/en/api/strings/glossary-term-translations/create-a-translation-for-a-term.md): Create a new translation for a term in a term base (previously: glossary). - [Delete a translation for a term](https://developers.phrase.com/en/api/strings/glossary-term-translations/delete-a-translation-for-a-term.md): Delete an existing translation of a term in a term base (previously: glossary). - [Update a translation for a term](https://developers.phrase.com/en/api/strings/glossary-term-translations/update-a-translation-for-a-term.md): Update an existing translation for a term in a term base (previously: glossary). #### Glossary Terms - [List terms](https://developers.phrase.com/en/api/strings/glossary-terms/list-terms.md): List all terms in term bases (previously: glossary) that the current user has access to. - [Create a term](https://developers.phrase.com/en/api/strings/glossary-terms/create-a-term.md): Create a new term in a term base (previously: glossary). - [Get a single term](https://developers.phrase.com/en/api/strings/glossary-terms/get-a-single-term.md): Get details for a single term in the term base (previously: glossary). - [Delete a term](https://developers.phrase.com/en/api/strings/glossary-terms/delete-a-term.md): Delete an existing term in a term base (previously: glossary). - [Update a term](https://developers.phrase.com/en/api/strings/glossary-terms/update-a-term.md): Update an existing term in a term base (previously: glossary). #### ICU - [Build ICU skeletons](https://developers.phrase.com/en/api/strings/icu/build-icu-skeletons.md): Generates ICU (International Components for Unicode) message format skeletons for a given source string across one or more locales. An ICU skeleton strips the literal text from a pluralized or select message while preserving its structural rules — argument names, plural categories, select cases, and… #### Invitations - [List invitations](https://developers.phrase.com/en/api/strings/invitations/list-invitations.md): 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`. - [Create a new invitation](https://developers.phrase.com/en/api/strings/invitations/create-a-new-invitation.md): 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`. - [Get a single invitation](https://developers.phrase.com/en/api/strings/invitations/get-a-single-invitation.md): Get details on a single invitation. Access token scope must include `team.manage`. - [Delete an invitation](https://developers.phrase.com/en/api/strings/invitations/delete-an-invitation.md): Delete an existing invitation (must not be accepted yet). Access token scope must include `team.manage`. - [Update an invitation](https://developers.phrase.com/en/api/strings/invitations/update-an-invitation.md): 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`. - [Resend an invitation](https://developers.phrase.com/en/api/strings/invitations/resend-an-invitation.md): Resend the invitation email (must not be accepted yet). Access token scope must include `team.manage`. - [Update a member's invitation access](https://developers.phrase.com/en/api/strings/invitations/update-a-members-invitation-access.md): Update member's settings in the invitations. Access token scope must include `team.manage`. #### Job Annotations - [List job annotations](https://developers.phrase.com/en/api/strings/job-annotations/list-job-annotations.md): Retrieve a list of annotations for a job. - [Delete a job annotation](https://developers.phrase.com/en/api/strings/job-annotations/delete-a-job-annotation.md): Delete an annotation for a job. - [Create/Update a job annotation](https://developers.phrase.com/en/api/strings/job-annotations/createupdate-a-job-annotation.md): Create or update an annotation for a job. If the annotation already exists, it will be updated; otherwise, a new annotation will be created. - [List job locale annotations](https://developers.phrase.com/en/api/strings/job-annotations/list-job-locale-annotations.md): Retrieve a list of annotations for a job locale. - [Delete a job locale annotation](https://developers.phrase.com/en/api/strings/job-annotations/delete-a-job-locale-annotation.md): Delete an annotation for a job locale. - [Create/Update a job locale annotation](https://developers.phrase.com/en/api/strings/job-annotations/createupdate-a-job-locale-annotation.md): 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. #### Job Comments - [Get a single job comment](https://developers.phrase.com/en/api/strings/job-comments/get-a-single-job-comment.md): Get details on a single job comment. - [Delete a job comment](https://developers.phrase.com/en/api/strings/job-comments/delete-a-job-comment.md): Delete an existing job comment. - [Update a job comment](https://developers.phrase.com/en/api/strings/job-comments/update-a-job-comment.md): Update an existing job comment. - [List job comments](https://developers.phrase.com/en/api/strings/job-comments/list-job-comments.md): List all comments for a job. - [Create a job comment](https://developers.phrase.com/en/api/strings/job-comments/create-a-job-comment.md): Create a new comment for a job. #### Job Locales - [List job target locales](https://developers.phrase.com/en/api/strings/job-locales/list-job-target-locales.md): List all target locales for a given job. - [Add a target locale to a job](https://developers.phrase.com/en/api/strings/job-locales/add-a-target-locale-to-a-job.md): Adds a target locale to a job. - [Show single job target locale](https://developers.phrase.com/en/api/strings/job-locales/show-single-job-target-locale.md): Get a single target locale for a given job. - [Remove a target locale from a job](https://developers.phrase.com/en/api/strings/job-locales/remove-a-target-locale-from-a-job.md): Removes a target locale from a job. - [Update a job target locale](https://developers.phrase.com/en/api/strings/job-locales/update-a-job-target-locale.md): Update an existing job target locale. - [Complete a job locale](https://developers.phrase.com/en/api/strings/job-locales/complete-a-job-locale.md): Mark a job locale as completed. - [Review a job locale](https://developers.phrase.com/en/api/strings/job-locales/review-a-job-locale.md): Mark job locale as reviewed. - [Reopen a job locale](https://developers.phrase.com/en/api/strings/job-locales/reopen-a-job-locale.md): Mark a job locale as uncompleted. #### Job Template Locales - [List job template locales](https://developers.phrase.com/en/api/strings/job-template-locales/list-job-template-locales.md): List all job template locales for a given job template. - [Create a job template locale](https://developers.phrase.com/en/api/strings/job-template-locales/create-a-job-template-locale.md): Create a new job template locale. - [Get a single job template locale](https://developers.phrase.com/en/api/strings/job-template-locales/get-a-single-job-template-locale.md): Get a single job template locale for a given job template. - [Delete a job template locale](https://developers.phrase.com/en/api/strings/job-template-locales/delete-a-job-template-locale.md): Delete an existing job template locale. - [Update a job template locale](https://developers.phrase.com/en/api/strings/job-template-locales/update-a-job-template-locale.md): Update an existing job template locale. #### Job Templates - [List job templates](https://developers.phrase.com/en/api/strings/job-templates/list-job-templates.md): List all job templates for the given project. - [Create a job template](https://developers.phrase.com/en/api/strings/job-templates/create-a-job-template.md): Create a new job template. - [Get a single job template](https://developers.phrase.com/en/api/strings/job-templates/get-a-single-job-template.md): Get details on a single job template for a given project. - [Delete a job template](https://developers.phrase.com/en/api/strings/job-templates/delete-a-job-template.md): Delete an existing job template. - [Update a job template](https://developers.phrase.com/en/api/strings/job-templates/update-a-job-template.md): Update an existing job template. #### Jobs - [List jobs](https://developers.phrase.com/en/api/strings/jobs/list-jobs.md): List all jobs for the given project. - [Create a job](https://developers.phrase.com/en/api/strings/jobs/create-a-job.md): Create a new job. - [List account jobs](https://developers.phrase.com/en/api/strings/jobs/list-account-jobs.md): List all jobs for the given account. - [Get a single job](https://developers.phrase.com/en/api/strings/jobs/get-a-single-job.md): Get details on a single job for a given project. - [Delete a job](https://developers.phrase.com/en/api/strings/jobs/delete-a-job.md): Delete an existing job. - [Update a job](https://developers.phrase.com/en/api/strings/jobs/update-a-job.md): Update an existing job. - [Start a job](https://developers.phrase.com/en/api/strings/jobs/start-a-job.md): Starts an existing job in state draft. - [Complete a job](https://developers.phrase.com/en/api/strings/jobs/complete-a-job.md): Mark a job as completed. - [Reopen a job](https://developers.phrase.com/en/api/strings/jobs/reopen-a-job.md): Mark a job as uncompleted. - [Lock a job](https://developers.phrase.com/en/api/strings/jobs/lock-a-job.md): If you are the job owner, you may lock a job using this API request. - [Unlock a job](https://developers.phrase.com/en/api/strings/jobs/unlock-a-job.md): If you are the job owner, you may unlock a locked job using this API request. - [Add keys to job](https://developers.phrase.com/en/api/strings/jobs/add-keys-to-job.md): Add multiple keys to a existing job. - [Remove keys from job](https://developers.phrase.com/en/api/strings/jobs/remove-keys-from-job.md): Remove multiple keys from existing job. #### Key Format Annotations - [List format annotations for a key](https://developers.phrase.com/en/api/strings/key-format-annotations/list-format-annotations-for-a-key.md): Returns the format annotations stored on a translation key. Format annotations capture file-format data recorded when the key was imported — for example, an ARB placeholder block or an XLIFF note. #### Key's Figma attachments - [Attach the Figma attachment to a key](https://developers.phrase.com/en/api/strings/keys-figma-attachments/attach-the-figma-attachment-to-a-key.md): Attach the Figma attachment to a key - [Detach the Figma attachment from a key](https://developers.phrase.com/en/api/strings/keys-figma-attachments/detach-the-figma-attachment-from-a-key.md): Detach the Figma attachment from a key #### Keys - [List keys](https://developers.phrase.com/en/api/strings/keys/list-keys.md): List all keys for the given project. Alternatively you can POST requests to /search. - [Create a key](https://developers.phrase.com/en/api/strings/keys/create-a-key.md): Create a new key. - [Delete collection of keys](https://developers.phrase.com/en/api/strings/keys/delete-collection-of-keys.md): 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. - [Search keys](https://developers.phrase.com/en/api/strings/keys/search-keys.md): Search keys for the given project matching query. - [Get a single key](https://developers.phrase.com/en/api/strings/keys/get-a-single-key.md): Get details on a single key for a given project. - [Delete a key](https://developers.phrase.com/en/api/strings/keys/delete-a-key.md): Delete an existing key. - [Update a key](https://developers.phrase.com/en/api/strings/keys/update-a-key.md): Update an existing key. - [Add tags to collection of keys](https://developers.phrase.com/en/api/strings/keys/add-tags-to-collection-of-keys.md): Tags all keys matching query. Same constraints as list. - [Remove tags from collection of keys](https://developers.phrase.com/en/api/strings/keys/remove-tags-from-collection-of-keys.md): Removes specified tags from keys matching query. - [Exclude a locale on a collection of keys](https://developers.phrase.com/en/api/strings/keys/exclude-a-locale-on-a-collection-of-keys.md): Exclude a locale on keys matching query. Same constraints as list. - [Include a locale on a collection of keys](https://developers.phrase.com/en/api/strings/keys/include-a-locale-on-a-collection-of-keys.md): Include a locale on keys matching query. Same constraints as list. #### Linked Keys - [List child keys of a parent key](https://developers.phrase.com/en/api/strings/linked-keys/list-child-keys-of-a-parent-key.md): Returns the key link record for a parent key, including all child keys associated with it. Key linking lets translation keys share translations — a child key inherits content from its designated parent. Use this endpoint to inspect which keys are linked under a given parent before unlinking them or… - [Link child keys to a parent key](https://developers.phrase.com/en/api/strings/linked-keys/link-child-keys-to-a-parent-key.md): Designates a translation key as a parent and links one or more child keys to it. Once linked, child keys receive a special reference marker as their translation content, signalling that their translations are derived from the parent. Use this when you want to group related keys — for example, a shor… - [Batch unlink child keys from a parent key](https://developers.phrase.com/en/api/strings/linked-keys/batch-unlink-child-keys-from-a-parent-key.md): Removes one or more child keys from a parent key's linked-key group, or dissolves the entire group by setting unlink_parent to true. - [Unlink a child key from a parent key](https://developers.phrase.com/en/api/strings/linked-keys/unlink-a-child-key-from-a-parent-key.md): Removes a single child key from a parent key's link group. A link group is the relationship model that keeps child keys synchronized with a parent: while linked, a child key's translations are derived from the parent's content. When you call this endpoint, the child key leaves the group and becomes… #### Locale Downloads - [Initiate async download of a locale](https://developers.phrase.com/en/api/strings/locale-downloads/initiate-async-download-of-a-locale.md): Prepare a locale for download in a specific file format. - [Show status of an async locale download](https://developers.phrase.com/en/api/strings/locale-downloads/show-status-of-an-async-locale-download.md): Show status of already started async locale download. If the download is finished, the download link will be returned. #### Locales - [List locales used in account](https://developers.phrase.com/en/api/strings/locales/list-locales-used-in-account.md): List all locales unique by locale code used across all projects within an account. - [List locales](https://developers.phrase.com/en/api/strings/locales/list-locales.md): List all locales for the given project. - [Create a locale](https://developers.phrase.com/en/api/strings/locales/create-a-locale.md): Create a new locale. - [Get a single locale](https://developers.phrase.com/en/api/strings/locales/get-a-single-locale.md): Get details on a single locale for a given project. - [Delete a locale](https://developers.phrase.com/en/api/strings/locales/delete-a-locale.md): Delete an existing locale. - [Update a locale](https://developers.phrase.com/en/api/strings/locales/update-a-locale.md): Update an existing locale. - [Download a locale](https://developers.phrase.com/en/api/strings/locales/download-a-locale.md): Download a locale in a specific file format. #### Members - [List members](https://developers.phrase.com/en/api/strings/members/list-members.md): 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`. - [Get single member](https://developers.phrase.com/en/api/strings/members/get-single-member.md): Get details on a single user in the account. Access token scope must include `team.manage`. - [Remove a user from the account](https://developers.phrase.com/en/api/strings/members/remove-a-user-from-the-account.md): 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`. - [Update a member](https://developers.phrase.com/en/api/strings/members/update-a-member.md): 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`. - [Update a member's project settings](https://developers.phrase.com/en/api/strings/members/update-a-members-project-settings.md): Update user settings in the project. Access token scope must include `team.manage`. #### Notification Groups - [List notification groups](https://developers.phrase.com/en/api/strings/notification-groups/list-notification-groups.md): List all notification groups from the current user - [Mark all notification groups as read](https://developers.phrase.com/en/api/strings/notification-groups/mark-all-notification-groups-as-read.md): Mark all notification groups of the current user as read - [Mark a notification group as read](https://developers.phrase.com/en/api/strings/notification-groups/mark-a-notification-group-as-read.md): Mark a notifications group of the current user as read #### Notifications - [List notifications](https://developers.phrase.com/en/api/strings/notifications/list-notifications.md): List all notifications from the current user - [Mark all notifications as read](https://developers.phrase.com/en/api/strings/notifications/mark-all-notifications-as-read.md): Mark all notifications of the current user as read - [Get a single notification](https://developers.phrase.com/en/api/strings/notifications/get-a-single-notification.md): Get details on a single notification. #### Orders - [List orders](https://developers.phrase.com/en/api/strings/orders/list-orders.md): List all orders for the given project. - [Create a new order](https://developers.phrase.com/en/api/strings/orders/create-a-new-order.md): Create a new order. Access token scope must include `orders.create`. - [Get a single order](https://developers.phrase.com/en/api/strings/orders/get-a-single-order.md): Get details on a single order. - [Cancel an order](https://developers.phrase.com/en/api/strings/orders/cancel-an-order.md): Cancel an existing order. Must not yet be confirmed. - [Confirm an order](https://developers.phrase.com/en/api/strings/orders/confirm-an-order.md): Confirm an existing order and send it to the provider for translation. Same constraints as for create. #### Organization Job Template Locales - [List organization job template locales](https://developers.phrase.com/en/api/strings/organization-job-template-locales/list-organization-job-template-locales.md): List all job template locales for a given organization job template. - [Create an organization job template locale](https://developers.phrase.com/en/api/strings/organization-job-template-locales/create-an-organization-job-template-locale.md): Create a new organization job template locale. - [Get a single organization job template locale](https://developers.phrase.com/en/api/strings/organization-job-template-locales/get-a-single-organization-job-template-locale.md): Get a single job template locale for a given organization job template. - [Delete an organization job template locale](https://developers.phrase.com/en/api/strings/organization-job-template-locales/delete-an-organization-job-template-locale.md): Delete an existing organization job template locale. - [Update an organization job template locale](https://developers.phrase.com/en/api/strings/organization-job-template-locales/update-an-organization-job-template-locale.md): Update an existing organization job template locale. #### Organization Job Templates - [List organization job templates](https://developers.phrase.com/en/api/strings/organization-job-templates/list-organization-job-templates.md): List all job templates for the given account. - [Create an organization job template](https://developers.phrase.com/en/api/strings/organization-job-templates/create-an-organization-job-template.md): Create a new organization job template. - [Get a single organization job template](https://developers.phrase.com/en/api/strings/organization-job-templates/get-a-single-organization-job-template.md): Get details on a single organization job template for a given account. - [Delete an organization job template](https://developers.phrase.com/en/api/strings/organization-job-templates/delete-an-organization-job-template.md): Delete an existing organization job template. - [Update an organization job template](https://developers.phrase.com/en/api/strings/organization-job-templates/update-an-organization-job-template.md): Update an existing organization job template. #### Pre Translations - [List pre-translation jobs](https://developers.phrase.com/en/api/strings/pre-translations/list-pre-translation-jobs.md): Returns all pre-translation jobs scoped to a project, ordered by creation date descending. - [Create a pre-translation job](https://developers.phrase.com/en/api/strings/pre-translations/create-a-pre-translation-job.md): Triggers a pre-translation job for a resource within a project, addressed by `translatable_type` (`locale`, `job`, `translation_key`, or `upload`) and `translatable_id` (its ID). - [Get a single pre-translation job](https://developers.phrase.com/en/api/strings/pre-translations/get-a-single-pre-translation-job.md): Returns a single pre-translation job identified by its ID. #### Projects - [List projects](https://developers.phrase.com/en/api/strings/projects/list-projects.md): List all projects the current user has access to. - [Create a project](https://developers.phrase.com/en/api/strings/projects/create-a-project.md): Create a new project in the given account. - [Get a single project](https://developers.phrase.com/en/api/strings/projects/get-a-single-project.md): Get details on a single project. - [Delete a project](https://developers.phrase.com/en/api/strings/projects/delete-a-project.md): Delete an existing project. Associated repository syncs and OTA distributions are removed. A `project:delete` event is dispatched. - [Update a project](https://developers.phrase.com/en/api/strings/projects/update-a-project.md): Update an existing project. #### Quality performance score - [Get Translation Quality](https://developers.phrase.com/en/api/strings/quality-performance-score/get-translation-quality.md): Retrieves the quality scores for your Strings translations. Returns a score, measured by Phrase QPS #### Release Triggers - [List release triggers](https://developers.phrase.com/en/api/strings/release-triggers/list-release-triggers.md): List all release triggers for the given distribution. - [Create a release trigger](https://developers.phrase.com/en/api/strings/release-triggers/create-a-release-trigger.md): 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. - [Get a single release trigger](https://developers.phrase.com/en/api/strings/release-triggers/get-a-single-release-trigger.md): Get details of a single release trigger. - [Delete a single release trigger](https://developers.phrase.com/en/api/strings/release-triggers/delete-a-single-release-trigger.md): Delete a single release trigger. - [Update a release trigger](https://developers.phrase.com/en/api/strings/release-triggers/update-a-release-trigger.md): Update a recurring release. #### Releases - [List releases](https://developers.phrase.com/en/api/strings/releases/list-releases.md): List all releases for the given distribution. - [Create a release](https://developers.phrase.com/en/api/strings/releases/create-a-release.md): Create a new release. - [Get a single release](https://developers.phrase.com/en/api/strings/releases/get-a-single-release.md): Get details on a single release. - [Delete a release](https://developers.phrase.com/en/api/strings/releases/delete-a-release.md): Delete an existing release. - [Update a release](https://developers.phrase.com/en/api/strings/releases/update-a-release.md): Update an existing release. - [Publish a release](https://developers.phrase.com/en/api/strings/releases/publish-a-release.md): Publish a release for production. #### Repo Sync Events - [Repository Syncs History](https://developers.phrase.com/en/api/strings/repo-sync-events/repository-syncs-history.md): Get the history of a single Repo Sync. The history includes all imports and exports performed by the Repo Sync. - [Get a single Repo Sync Event](https://developers.phrase.com/en/api/strings/repo-sync-events/get-a-single-repo-sync-event.md): Shows a single Repo Sync event. #### Repo Syncs - [Get Repo Syncs](https://developers.phrase.com/en/api/strings/repo-syncs/get-repo-syncs.md): Lists all Repo Syncs from an account - [Create a Repo Sync](https://developers.phrase.com/en/api/strings/repo-syncs/create-a-repo-sync.md): Create a new Repo Sync. - [Get a single Repo Sync](https://developers.phrase.com/en/api/strings/repo-syncs/get-a-single-repo-sync.md): Shows a single Repo Sync setting. - [Export to code repository](https://developers.phrase.com/en/api/strings/repo-syncs/export-to-code-repository.md): Export translations from Phrase Strings to repository provider according to the .phrase.yml file within the code repository. - [Import from code repository](https://developers.phrase.com/en/api/strings/repo-syncs/import-from-code-repository.md): Import translations from repository provider to Phrase Strings according to the .phrase.yml file within the code repository. - [Deactivate a Repo Sync](https://developers.phrase.com/en/api/strings/repo-syncs/deactivate-a-repo-sync.md): 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. - [Activate a Repo Sync](https://developers.phrase.com/en/api/strings/repo-syncs/activate-a-repo-sync.md): 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. #### Reports - [Get Project Report](https://developers.phrase.com/en/api/strings/reports/get-project-report.md): Get report of a single project. - [List Locale Reports](https://developers.phrase.com/en/api/strings/reports/list-locale-reports.md): List all locale reports for the given project #### Screenshot Markers - [List screenshot markers](https://developers.phrase.com/en/api/strings/screenshot-markers/list-screenshot-markers.md): List all screenshot markers for the given project. - [Get a single screenshot marker](https://developers.phrase.com/en/api/strings/screenshot-markers/get-a-single-screenshot-marker.md): Get details on a single screenshot marker for a given project. - [Create a screenshot marker](https://developers.phrase.com/en/api/strings/screenshot-markers/create-a-screenshot-marker.md): Create a new screenshot marker. - [Delete a screenshot marker](https://developers.phrase.com/en/api/strings/screenshot-markers/delete-a-screenshot-marker.md): Delete an existing screenshot marker. - [Update a screenshot marker](https://developers.phrase.com/en/api/strings/screenshot-markers/update-a-screenshot-marker.md): Update an existing screenshot marker. #### Screenshots - [List screenshots](https://developers.phrase.com/en/api/strings/screenshots/list-screenshots.md): List all screenshots for the given project. - [Create a screenshot](https://developers.phrase.com/en/api/strings/screenshots/create-a-screenshot.md): Creates a screenshot in a project to provide visual context for in-context translation. Attach translation keys to regions of the uploaded image so translators can see where each string appears in your UI. - [Get a single screenshot](https://developers.phrase.com/en/api/strings/screenshots/get-a-single-screenshot.md): Returns a single screenshot belonging to the specified project. Use this to retrieve the screenshot's name, description, hosted image URL, and marker count after uploading, or before creating, updating, or inspecting its markers. The response is a synchronous, idempotent read — repeated calls return… - [Delete a screenshot](https://developers.phrase.com/en/api/strings/screenshots/delete-a-screenshot.md): Permanently removes a screenshot and all its associated markers from the project. Use this when you need to fully remove a screenshot that is no longer relevant — for example, after a UI redesign renders the captured screen obsolete. This is a hard delete: the screenshot record and every key-to-regi… - [Update a screenshot](https://developers.phrase.com/en/api/strings/screenshots/update-a-screenshot.md): Update an existing screenshot. #### Search - [Search across projects](https://developers.phrase.com/en/api/strings/search/search-across-projects.md): Search for keys and translations in all account projects #### Spaces - [List Spaces](https://developers.phrase.com/en/api/strings/spaces/list-spaces.md): List all Spaces for the given account. - [Create a Space](https://developers.phrase.com/en/api/strings/spaces/create-a-space.md): Create a new Space. - [Get Space](https://developers.phrase.com/en/api/strings/spaces/get-space.md): Show the specified Space. - [Delete Space](https://developers.phrase.com/en/api/strings/spaces/delete-space.md): Delete the specified Space. - [Update Space](https://developers.phrase.com/en/api/strings/spaces/update-space.md): Update the specified Space. - [List Projects in Space](https://developers.phrase.com/en/api/strings/spaces/list-projects-in-space.md): List all projects for the specified Space. - [Add Project to Space](https://developers.phrase.com/en/api/strings/spaces/add-project-to-space.md): Adds an existing project to the space. - [Remove Project from Space](https://developers.phrase.com/en/api/strings/spaces/remove-project-from-space.md): Removes a specified project from the specified space. #### Style guides - [List style guides](https://developers.phrase.com/en/api/strings/style-guides/list-style-guides.md): List all styleguides for the given project. - [Create a style guide](https://developers.phrase.com/en/api/strings/style-guides/create-a-style-guide.md): Create a new style guide. - [Get a single style guide](https://developers.phrase.com/en/api/strings/style-guides/get-a-single-style-guide.md): Get details on a single style guide. - [Delete a style guide](https://developers.phrase.com/en/api/strings/style-guides/delete-a-style-guide.md): Delete an existing style guide. - [Update a style guide](https://developers.phrase.com/en/api/strings/style-guides/update-a-style-guide.md): Update an existing style guide. #### Tags - [List tags](https://developers.phrase.com/en/api/strings/tags/list-tags.md): List all tags for the given project. - [Create a tag](https://developers.phrase.com/en/api/strings/tags/create-a-tag.md): Create a new tag. - [Get a single tag](https://developers.phrase.com/en/api/strings/tags/get-a-single-tag.md): Get details and progress information on a single tag for a given project. - [Delete a tag](https://developers.phrase.com/en/api/strings/tags/delete-a-tag.md): Delete an existing tag. #### Teams - [List Teams](https://developers.phrase.com/en/api/strings/teams/list-teams.md): List all Teams for the given account. - [Create a Team](https://developers.phrase.com/en/api/strings/teams/create-a-team.md): Create a new Team. - [Get Team](https://developers.phrase.com/en/api/strings/teams/get-team.md): Show the specified Team. - [Delete Team](https://developers.phrase.com/en/api/strings/teams/delete-team.md): Delete the specified Team. - [Update Team](https://developers.phrase.com/en/api/strings/teams/update-team.md): Update the specified Team. - [Add Project to Team](https://developers.phrase.com/en/api/strings/teams/add-project-to-team.md): Adds an existing project to the team. - [Remove Project from Team](https://developers.phrase.com/en/api/strings/teams/remove-project-from-team.md): Removes a specified project from the specified team. - [Add Space](https://developers.phrase.com/en/api/strings/teams/add-space.md): Adds an existing space to the team. - [Remove Space](https://developers.phrase.com/en/api/strings/teams/remove-space.md): Removes a specified space from the specified team. - [Add User](https://developers.phrase.com/en/api/strings/teams/add-user.md): Adds an existing user to the team. - [Remove User](https://developers.phrase.com/en/api/strings/teams/remove-user.md): Removes a specified user from the specified team. #### Translations - [List all translations](https://developers.phrase.com/en/api/strings/translations/list-all-translations.md): List translations for the given project. If you want to download all translations for one locale we recommend to use the `locales#download` endpoint. - [Create a translation](https://developers.phrase.com/en/api/strings/translations/create-a-translation.md): Create a translation. - [List translations by locale](https://developers.phrase.com/en/api/strings/translations/list-translations-by-locale.md): List translations for a specific locale. If you want to download all translations for one locale we recommend to use the `locales#download` endpoint. - [List translations by key](https://developers.phrase.com/en/api/strings/translations/list-translations-by-key.md): List translations for a specific key. - [Search translations](https://developers.phrase.com/en/api/strings/translations/search-translations.md): 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. - [Get a single translation](https://developers.phrase.com/en/api/strings/translations/get-a-single-translation.md): Get details on a single translation. - [Update a translation](https://developers.phrase.com/en/api/strings/translations/update-a-translation.md): Update an existing translation. - [Verify a translation](https://developers.phrase.com/en/api/strings/translations/verify-a-translation.md): Verify an existing translation. - [Mark a translation as unverified](https://developers.phrase.com/en/api/strings/translations/mark-a-translation-as-unverified.md): Mark an existing translation as unverified. - [Review a translation](https://developers.phrase.com/en/api/strings/translations/review-a-translation.md): Mark an existing translation as reviewed. - [Unreview a translation](https://developers.phrase.com/en/api/strings/translations/unreview-a-translation.md): Mark a reviewed translation as translated. - [Exclude a translation from export](https://developers.phrase.com/en/api/strings/translations/exclude-a-translation-from-export.md): Set exclude from export flag on an existing translation. - [Include a translation](https://developers.phrase.com/en/api/strings/translations/include-a-translation.md): Remove exclude from export flag from an existing translation. - [Verify translations by query](https://developers.phrase.com/en/api/strings/translations/verify-translations-by-query.md): Verify translations matching query. - [Unverify translations by query](https://developers.phrase.com/en/api/strings/translations/unverify-translations-by-query.md): Mark translations matching query as unverified. - [Review translations selected by query](https://developers.phrase.com/en/api/strings/translations/review-translations-selected-by-query.md): Review translations matching query. - [Unreview translations selected by query](https://developers.phrase.com/en/api/strings/translations/unreview-translations-selected-by-query.md): Unreview translations matching query. - [Exclude translations by query](https://developers.phrase.com/en/api/strings/translations/exclude-translations-by-query.md): Exclude translations matching query from locale export. - [Include translations by query](https://developers.phrase.com/en/api/strings/translations/include-translations-by-query.md): Include translations matching query in locale export. #### Upload Batches - [Create upload batch](https://developers.phrase.com/en/api/strings/upload-batches/create-upload-batch.md): Groups multiple file uploads into a single batch. Optionally, launches the deletion of unmentioned translation keys after all uploads in the batch are completed. #### Uploads - [List uploads](https://developers.phrase.com/en/api/strings/uploads/list-uploads.md): List all uploads for the given project. - [Upload a new file](https://developers.phrase.com/en/api/strings/uploads/upload-a-new-file.md): Upload a new language file. Creates necessary resources in your project. - [Get a single upload](https://developers.phrase.com/en/api/strings/uploads/get-a-single-upload.md): View details and summary for a single upload. #### Users - [Show current User](https://developers.phrase.com/en/api/strings/users/show-current-user.md): Show details for current User. #### Variables - [List variables](https://developers.phrase.com/en/api/strings/variables/list-variables.md): List all variables for the current project. - [Create a variable](https://developers.phrase.com/en/api/strings/variables/create-a-variable.md): Create a new variable. - [Get a single variable](https://developers.phrase.com/en/api/strings/variables/get-a-single-variable.md): Get details on a single variable for a given project. - [Delete a variable](https://developers.phrase.com/en/api/strings/variables/delete-a-variable.md): Delete an existing variable. - [Update a variable](https://developers.phrase.com/en/api/strings/variables/update-a-variable.md): Update an existing variable. #### Versions / History - [List all versions](https://developers.phrase.com/en/api/strings/versions-history/list-all-versions.md): List all changes done to a given translation. - [Get a single version](https://developers.phrase.com/en/api/strings/versions-history/get-a-single-version.md): Get details on a single version. #### Webhook Deliveries - [List webhook deliveries](https://developers.phrase.com/en/api/strings/webhook-deliveries/list-webhook-deliveries.md): List all webhook deliveries for the given webhook_id. - [Get a single webhook delivery](https://developers.phrase.com/en/api/strings/webhook-deliveries/get-a-single-webhook-delivery.md): Get all information about a single webhook delivery for the given ID. - [Redeliver a single webhook delivery](https://developers.phrase.com/en/api/strings/webhook-deliveries/redeliver-a-single-webhook-delivery.md): Trigger an individual webhook delivery to be redelivered. #### Webhooks - [List webhooks](https://developers.phrase.com/en/api/strings/webhooks/list-webhooks.md): List all webhooks for the given project. - [Create a webhook](https://developers.phrase.com/en/api/strings/webhooks/create-a-webhook.md): Create a new webhook. - [Get a single webhook](https://developers.phrase.com/en/api/strings/webhooks/get-a-single-webhook.md): Get details on a single webhook. - [Delete a webhook](https://developers.phrase.com/en/api/strings/webhooks/delete-a-webhook.md): Delete an existing webhook. - [Update a webhook](https://developers.phrase.com/en/api/strings/webhooks/update-a-webhook.md): Update an existing webhook. - [Test a webhook](https://developers.phrase.com/en/api/strings/webhooks/test-a-webhook.md): Perform a test request for a webhook. Sends a synthetic `test:event` payload to the webhook's `callback_url` and returns the webhook resource. ## OpenAPI Specs - [phrase-strings](/openapi/phrase-strings.json)