Phrase

Phrase Strings API

Phrase Strings is a translation management platform for software projects. You can collaborate on language file translation with your team or order…

Developer tools#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Phrase Strings is a translation management platform for software projects. You can collaborate on language file translation with your team or order translations through our platform. The API allows you to import locale files, download locale files, tag keys or interact in other ways with the localization data stored in Phrase Strings for your account.

Endpoints 302

Accounts

  • GETList accounts/accountsList all accounts the current user has access to.
  • GETGet a single account/accounts/:idGet details on a single account.

Authorizations

  • GETList authorizations/authorizationsList all your authorizations.
  • POSTCreate an authorization/authorizationsCreate a new authorization.
  • GETGet a single authorization/authorizations/:idGet details on a single authorization.
  • DELETEDelete an authorization/authorizations/:idDelete an existing authorization. API calls using that token will stop working.
  • PATCHUpdate an authorization/authorizations/:idUpdate an existing authorization.

Automation Events

  • GETList events for an automation/accounts/:account_id/automations/:automation_id/eventsReturns the run history for a specific automation, newest-first. For feature availability, see Jobs (Strings).
  • GETList automation events for an account/accounts/:account_id/automation_eventsReturns the run history across all automations in the account, newest-first. Use automation_id to narrow results to a single automation. Use project_id or…

Blacklisted Keys

  • GETList blocked keys/projects/:project_id/blacklisted_keysList all rules for blocking keys for the given project.
  • POSTCreate a blocked key/projects/:project_id/blacklisted_keysCreate a new rule for blocking keys.
  • GETGet a single blocked key/projects/:project_id/blacklisted_keys/:idGet details on a single rule for blocking keys for a given project.
  • DELETEDelete a blocked key/projects/:project_id/blacklisted_keys/:idDelete an existing rule for blocking keys.
  • PATCHUpdate a blocked key/projects/:project_id/blacklisted_keys/:idUpdate an existing rule for blocking keys.

Branches

  • GETList branches/projects/:project_id/branchesList all branches of the current project. Requires the Branching feature to be enabled on the account.
  • POSTCreate a branch/projects/:project_id/branchesCreate a new branch. Branch project provisioning runs asynchronously, so the newly created branch is returned in a transitional state (typically…
  • GETGet a single branch/projects/:project_id/branches/:nameGet details on a single branch for a given project. Requires the Branching feature to be enabled on the account.
  • DELETEDelete a branch/projects/:project_id/branches/:nameDelete an existing branch. A branch cannot be deleted while it still has open jobs or open translation orders attached to its branch project — in that case…
  • PATCHUpdate a branch/projects/:project_id/branches/:nameUpdate an existing branch. Only the branch name can be changed. Requires the Branching feature to be enabled on the account.
  • PATCHMerge a branch/projects/:project_id/branches/:name/mergeMerge an existing branch back into its base branch. The merge runs asynchronously. The branch transitions to merging_branch and settles in merged,…
  • PATCHSync a branch/projects/:project_id/branches/:name/syncPull changes from the base branch into this branch, applying the chosen conflict-resolution strategy. The sync runs asynchronously. The branch transitions to…
  • GETCompare branches/projects/:project_id/branches/:name/compareCompare branch with main branch. *Note: Comparing a branch may take several minutes depending on the project size. Consider using the POST /compare endpoint…
  • POSTCreate comparison (async.)/projects/:project_id/branches/:name/compareCreate a branch comparison asynchronously.

Checks

  • GETList check issues/projects/:project_id/checks/issuesNote: The Checks API is still in development and might change in subsequent releases. List check issues for the given project. Results can be filtered by…
  • PATCHDismiss a check issue/projects/:project_id/checks/issues/:id/dismissNote: The Checks API is still in development and might change in subsequent releases. Mark a check issue as dismissed so it no longer appears on the list of…

Comments

  • GETList comments/projects/:project_id/keys/:key_id/commentsList all comments for a key.
  • POSTCreate a comment/projects/:project_id/keys/:key_id/commentsCreate a new comment for a key.
  • GETGet a single comment/projects/:project_id/keys/:key_id/comments/:idGet details on a single comment.
  • DELETEDelete a comment/projects/:project_id/keys/:key_id/comments/:idDelete an existing comment.
  • PATCHUpdate a comment/projects/:project_id/keys/:key_id/comments/:idUpdate an existing comment.
  • GETCheck if comment is read/projects/:project_id/keys/:key_id/comments/:id/readCheck if comment was marked as read. Returns 204 if read, 404 if unread.
  • DELETEMark a comment as unread/projects/:project_id/keys/:key_id/comments/:id/readMark a comment as unread.
  • PATCHMark a comment as read/projects/:project_id/keys/:key_id/comments/:id/readMark a comment as read.

Comment Reactions

  • GETList reactions/projects/:project_id/keys/:key_id/comments/:comment_id/reactionsList all reactions for a comment.
  • POSTCreate a reaction/projects/:project_id/keys/:key_id/comments/:comment_id/reactionsCreate a new reaction for a comment.
  • GETGet a single reaction/projects/:project_id/keys/:key_id/comments/:comment_id/reactions/:idGet details on a single reaction.
  • DELETEDelete a reaction/projects/:project_id/keys/:key_id/comments/:comment_id/reactions/:idDelete an existing reaction.

Comment Replies

  • GETList replies/projects/:project_id/keys/:key_id/comments/:comment_id/repliesList all replies for a comment.
  • POSTCreate a reply/projects/:project_id/keys/:key_id/comments/:comment_id/repliesCreate a new reply for a comment.
  • GETGet a single reply/projects/:project_id/keys/:key_id/comments/:comment_id/replies/:idGet details on a single reply.
  • DELETEDelete a reply/projects/:project_id/keys/:key_id/comments/:comment_id/replies/:idDelete an existing reply.
  • PATCHMark a reply as read/projects/:project_id/keys/:key_id/comments/:comment_id/replies/:id/mark_as_readMark a reply as read.
  • PATCHMark a reply as unread/projects/:project_id/keys/:key_id/comments/:comment_id/replies/:id/mark_as_unreadMark a reply as unread.

Custom Metadata

  • GETList properties/accounts/:account_id/custom_metadata/propertiesList all custom metadata properties for an account. This endpoint is only available to accounts with advanced plans or above.
  • POSTCreate a property/accounts/:account_id/custom_metadata/propertiesCreate a new custom metadata property.
  • GETGet a single property/accounts/:account_id/custom_metadata/properties/:idGet details of a single custom property.
  • DELETEDestroy property/accounts/:account_id/custom_metadata/properties/:idDestroy a custom metadata property of an account. This endpoint is only available to accounts with advanced plans or above.
  • PATCHUpdate a property/accounts/:account_id/custom_metadata/properties/:idUpdate an existing custom metadata property.

Distributions

  • GETList distributions/accounts/:account_id/distributionsList all distributions for the given account.
  • POSTCreate a distribution/accounts/:account_id/distributionsCreate a new distribution.
  • GETGet a single distribution/accounts/:account_id/distributions/:idGet details on a single distribution.
  • DELETEDelete a distribution/accounts/:account_id/distributions/:idDelete an existing distribution.
  • PATCHUpdate a distribution/accounts/:account_id/distributions/:idUpdate an existing distribution.

Documents

  • GETList documents/projects/:project_id/documentsReturns 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…
  • DELETEDelete document/projects/:project_id/documents/:idPermanently 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…

Formats

  • GETList formats/formatsReturns all file formats that Phrase Strings supports. Use the api_name value from each format as the file_format parameter when uploading or downloading…

Glossaries

  • GETList term bases/accounts/:account_id/glossariesList all term bases (previously: glossaries) the current user has access to.
  • POSTCreate a term base/accounts/:account_id/glossariesCreate a new term base (previously: glossary).
  • GETGet a single term base/accounts/:account_id/glossaries/:idGet details on a single term base (previously: glossary).
  • DELETEDelete a term base/accounts/:account_id/glossaries/:idDelete an existing term base (previously: glossary).
  • PATCHUpdate a term base/accounts/:account_id/glossaries/:idUpdate an existing term base (previously: glossary).

Glossary Terms

  • GETList terms/accounts/:account_id/glossaries/:glossary_id/termsList all terms in term bases (previously: glossary) that the current user has access to.
  • POSTCreate a term/accounts/:account_id/glossaries/:glossary_id/termsCreate a new term in a term base (previously: glossary).
  • GETGet a single term/accounts/:account_id/glossaries/:glossary_id/terms/:idGet details for a single term in the term base (previously: glossary).
  • DELETEDelete a term/accounts/:account_id/glossaries/:glossary_id/terms/:idDelete an existing term in a term base (previously: glossary).
  • PATCHUpdate a term/accounts/:account_id/glossaries/:glossary_id/terms/:idUpdate an existing term in a term base (previously: glossary).

Glossary Term Translations

  • POSTCreate a translation for a term/accounts/:account_id/glossaries/:glossary_id/terms/:term_id/translationsCreate a new translation for a term in a term base (previously: glossary).
  • DELETEDelete a translation for a term/accounts/:account_id/glossaries/:glossary_id/terms/:term_id/translations/:idDelete an existing translation of a term in a term base (previously: glossary).
  • PATCHUpdate a translation for a term/accounts/:account_id/glossaries/:glossary_id/terms/:term_id/translations/:idUpdate an existing translation for a term in a term base (previously: glossary).

ICU

  • POSTBuild ICU skeletons/icu/skeletonGenerates ICU (International Components for Unicode) message format skeletons for a given source string across one or more locales. An ICU skeleton strips the…

Invitations

  • GETList invitations/accounts/:account_id/invitationsList 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…
  • POSTCreate a new invitation/accounts/:account_id/invitationsInvite 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.
  • GETGet a single invitation/accounts/:account_id/invitations/:idGet details on a single invitation. Access token scope must include team.manage.
  • DELETEDelete an invitation/accounts/:account_id/invitations/:idDelete an existing invitation (must not be accepted yet). Access token scope must include team.manage.
  • PATCHUpdate an invitation/accounts/:account_id/invitations/:idUpdate an existing invitation (must not be accepted yet). The email cannot be updated. Developers and translators need project_ids and locale_ids assigned to…
  • POSTResend an invitation/accounts/:account_id/invitations/:id/resendResend the invitation email (must not be accepted yet). Access token scope must include team.manage.
  • PATCHUpdate a member's invitation access/projects/:project_id/invitations/:idUpdate member's settings in the invitations. Access token scope must include team.manage.

Job Annotations

  • GETList job annotations/projects/:project_id/jobs/:job_id/annotationsRetrieve a list of annotations for a job.
  • DELETEDelete a job annotation/projects/:project_id/jobs/:job_id/annotations/:idDelete an annotation for a job.
  • PATCHCreate/Update a job annotation/projects/:project_id/jobs/:job_id/annotations/:idCreate or update an annotation for a job. If the annotation already exists, it will be updated; otherwise, a new annotation will be created.
  • GETList job locale annotations/projects/:project_id/jobs/:job_id/locales/:job_locale_id/annotationsRetrieve a list of annotations for a job locale.
  • DELETEDelete a job locale annotation/projects/:project_id/jobs/:job_id/locales/:job_locale_id/annotations/:idDelete an annotation for a job locale.
  • PATCHCreate/Update a job locale annotation/projects/:project_id/jobs/:job_id/locales/:job_locale_id/annotations/:idCreate 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

  • GETGet a single job comment/projects/:project_id/jobs/:job_id/comments/:idGet details on a single job comment.
  • DELETEDelete a job comment/projects/:project_id/jobs/:job_id/comments/:idDelete an existing job comment.
  • PATCHUpdate a job comment/projects/:project_id/jobs/:job_id/comments/:idUpdate an existing job comment.
  • GETList job comments/projects/:project_id/jobs/:job_id/commentsList all comments for a job.
  • POSTCreate a job comment/projects/:project_id/jobs/:job_id/commentsCreate a new comment for a job.

Job Locales

  • GETList job target locales/projects/:project_id/jobs/:job_id/localesList all target locales for a given job.
  • POSTAdd a target locale to a job/projects/:project_id/jobs/:job_id/localesAdds a target locale to a job.
  • GETShow single job target locale/projects/:project_id/jobs/:job_id/locales/:idGet a single target locale for a given job.
  • DELETERemove a target locale from a job/projects/:project_id/jobs/:job_id/locales/:idRemoves a target locale from a job.
  • PATCHUpdate a job target locale/projects/:project_id/jobs/:job_id/locales/:idUpdate an existing job target locale.
  • POSTComplete a job locale/projects/:project_id/jobs/:job_id/locales/:id/completeMark a job locale as completed.
  • POSTReview a job locale/projects/:project_id/jobs/:job_id/locales/:id/complete_reviewMark job locale as reviewed.
  • POSTReopen a job locale/projects/:project_id/jobs/:job_id/locales/:id/reopenMark a job locale as uncompleted.

Job Template Locales

  • GETList job template locales/projects/:project_id/job_templates/:job_template_id/localesList all job template locales for a given job template.
  • POSTCreate a job template locale/projects/:project_id/job_templates/:job_template_id/localesCreate a new job template locale.
  • GETGet a single job template locale/projects/:project_id/job_templates/:job_template_id/locales/:job_template_locale_idGet a single job template locale for a given job template.
  • DELETEDelete a job template locale/projects/:project_id/job_templates/:job_template_id/locales/:job_template_locale_idDelete an existing job template locale.
  • PATCHUpdate a job template locale/projects/:project_id/job_templates/:job_template_id/locales/:job_template_locale_idUpdate an existing job template locale.

Job Templates

  • GETList job templates/projects/:project_id/job_templatesList all job templates for the given project.
  • POSTCreate a job template/projects/:project_id/job_templatesCreate a new job template.
  • GETGet a single job template/projects/:project_id/job_templates/:idGet details on a single job template for a given project.
  • DELETEDelete a job template/projects/:project_id/job_templates/:idDelete an existing job template.
  • PATCHUpdate a job template/projects/:project_id/job_templates/:idUpdate an existing job template.

Jobs

  • GETList jobs/projects/:project_id/jobsList all jobs for the given project.
  • POSTCreate a job/projects/:project_id/jobsCreate a new job.
  • GETList account jobs/accounts/:account_id/jobsList all jobs for the given account.
  • GETGet a single job/projects/:project_id/jobs/:idGet details on a single job for a given project.
  • DELETEDelete a job/projects/:project_id/jobs/:idDelete an existing job.
  • PATCHUpdate a job/projects/:project_id/jobs/:idUpdate an existing job.
  • POSTStart a job/projects/:project_id/jobs/:id/startStarts an existing job in state draft.
  • POSTComplete a job/projects/:project_id/jobs/:id/completeMark a job as completed.
  • POSTReopen a job/projects/:project_id/jobs/:id/reopenMark a job as uncompleted.
  • POSTLock a job/projects/:project_id/jobs/:id/lockIf you are the job owner, you may lock a job using this API request.
  • POSTUnlock a job/projects/:project_id/jobs/:id/unlockIf you are the job owner, you may unlock a locked job using this API request.
  • POSTAdd keys to job/projects/:project_id/jobs/:id/keysAdd multiple keys to a existing job.
  • DELETERemove keys from job/projects/:project_id/jobs/:id/keysRemove multiple keys from existing job.

Key Format Annotations

  • GETList format annotations for a key/projects/:project_id/keys/:id/format_annotationsReturns the format annotations stored on a translation key. Format annotations capture file-format data recorded when the key was imported — for example, an…

Keys

  • GETList keys/projects/:project_id/keysList all keys for the given project. Alternatively you can POST requests to /search.
  • POSTCreate a key/projects/:project_id/keysCreate a new key.
  • DELETEDelete collection of keys/projects/:project_id/keysDelete 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.
  • POSTSearch keys/projects/:project_id/keys/searchSearch keys for the given project matching query.
  • GETGet a single key/projects/:project_id/keys/:idGet details on a single key for a given project.
  • DELETEDelete a key/projects/:project_id/keys/:idDelete an existing key.
  • PATCHUpdate a key/projects/:project_id/keys/:idUpdate an existing key.
  • PATCHAdd tags to collection of keys/projects/:project_id/keys/tagTags all keys matching query. Same constraints as list.
  • PATCHRemove tags from collection of keys/projects/:project_id/keys/untagRemoves specified tags from keys matching query.
  • PATCHExclude a locale on a collection of keys/projects/:project_id/keys/excludeExclude a locale on keys matching query. Same constraints as list.
  • PATCHInclude a locale on a collection of keys/projects/:project_id/keys/includeInclude a locale on keys matching query. Same constraints as list.

Linked Keys

  • GETList child keys of a parent key/projects/:project_id/keys/:id/key_linksReturns 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…
  • POSTLink child keys to a parent key/projects/:project_id/keys/:id/key_linksDesignates 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…
  • DELETEBatch unlink child keys from a parent key/projects/:project_id/keys/:id/key_linksRemoves one or more child keys from a parent key's linked-key group, or dissolves the entire group by setting unlink_parent to true. Use this when you need to…
  • DELETEUnlink a child key from a parent key/projects/:project_id/keys/:id/key_links/:child_key_idRemoves 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…

Locales

  • GETList locales used in account/accounts/:id/localesList all locales unique by locale code used across all projects within an account.
  • GETList locales/projects/:project_id/localesList all locales for the given project.
  • POSTCreate a locale/projects/:project_id/localesCreate a new locale.
  • GETGet a single locale/projects/:project_id/locales/:idGet details on a single locale for a given project.
  • DELETEDelete a locale/projects/:project_id/locales/:idDelete an existing locale.
  • PATCHUpdate a locale/projects/:project_id/locales/:idUpdate an existing locale.
  • GETDownload a locale/projects/:project_id/locales/:id/downloadDownload a locale in a specific file format.

Locale Downloads

  • POSTInitiate async download of a locale/projects/:project_id/locales/:locale_id/downloadsPrepare a locale for download in a specific file format.
  • GETShow status of an async locale download/projects/:project_id/locales/:locale_id/downloads/:idShow status of already started async locale download. If the download is finished, the download link will be returned.

Machine Translation

  • GETGet machine translation settings/accounts/:account_id/machine_translation_settingsReturns the machine translation configuration for the account, including the default translation service, current machine translation unit usage, and any…
  • PATCHUpdate machine translation settings/accounts/:account_id/machine_translation_settingsSets the default machine translation service for the account. Requires write access to the account's machine translation settings. Passing an empty or absent…
  • POSTCreate a locale provider mapping/accounts/:account_id/machine_translation_locale_provider_mappingsCreates a locale-pair-specific machine translation provider override for the account. When a mapping exists for a given source/target locale pair, that…
  • DELETEDelete a locale provider mapping/accounts/:account_id/machine_translation_locale_provider_mappings?source_locale_code=en&target_locale_code=deRemoves the machine translation provider override for the specified source and target locale pair. The mapping is identified by locale codes supplied as query…

Members

  • GETList members/accounts/:account_id/membersGet 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…
  • GETGet single member/accounts/:account_id/members/:idGet details on a single user in the account. Access token scope must include team.manage.
  • DELETERemove a user from the account/accounts/:account_id/members/:idRemove 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.
  • PATCHUpdate a member/accounts/:account_id/members/:idUpdate user permissions in the account. Developers and translators need project_ids and locale_ids assigned to access them. To grant account-wide language…
  • GETList project members/projects/:project_id/membersGet all members active in the project. Access token scope must include read.
  • PATCHUpdate a member's project settings/projects/:project_id/members/:idUpdate user settings in the project. Access token scope must include team.manage.

Notifications

  • GETList notifications/notificationsList all notifications from the current user
  • POSTMark all notifications as read/notifications/mark_all_as_readMark all notifications of the current user as read
  • GETGet a single notification/notifications/:idGet details on a single notification.

Notification Groups

  • GETList notification groups/notification_groupsList all notification groups from the current user
  • PATCHMark all notification groups as read/notification_groups/mark_all_as_readMark all notification groups of the current user as read
  • PATCHMark a notification group as read/notification_groups/:id/mark_as_readMark a notifications group of the current user as read

Orders

  • GETList orders/projects/:project_id/ordersList all orders for the given project.
  • POSTCreate a new order/projects/:project_id/ordersCreate a new order. Access token scope must include orders.create.
  • GETGet a single order/projects/:project_id/orders/:idGet details on a single order.
  • DELETECancel an order/projects/:project_id/orders/:idCancel an existing order. Must not yet be confirmed.
  • PATCHConfirm an order/projects/:project_id/orders/:id/confirmConfirm an existing order and send it to the provider for translation. Same constraints as for create.

Organization Job Template Locales

  • GETList organization job template locales/accounts/:account_id/job_templates/:job_template_id/localesList all job template locales for a given organization job template.
  • POSTCreate an organization job template locale/accounts/:account_id/job_templates/:job_template_id/localesCreate a new organization job template locale.
  • GETGet a single organization job template locale/accounts/:account_id/job_templates/:job_template_id/locales/:job_template_locale_idGet a single job template locale for a given organization job template.
  • DELETEDelete an organization job template locale/accounts/:account_id/job_templates/:job_template_id/locales/:job_template_locale_idDelete an existing organization job template locale.
  • PATCHUpdate an organization job template locale/accounts/:account_id/job_templates/:job_template_id/locales/:job_template_locale_idUpdate an existing organization job template locale.

Organization Job Templates

  • GETList organization job templates/accounts/:account_id/job_templatesList all job templates for the given account.
  • POSTCreate an organization job template/accounts/:account_id/job_templatesCreate a new organization job template.
  • GETGet a single organization job template/accounts/:account_id/job_templates/:idGet details on a single organization job template for a given account.
  • DELETEDelete an organization job template/accounts/:account_id/job_templates/:idDelete an existing organization job template.
  • PATCHUpdate an organization job template/accounts/:account_id/job_templates/:idUpdate an existing organization job template.

Pre Translations

  • GETList pre-translation jobs/projects/:project_id/pre_translationsReturns all pre-translation jobs scoped to a project, ordered by creation date descending.
  • POSTCreate a pre-translation job/projects/:project_id/pre_translationsTriggers a pre-translation job for a resource within a project, addressed by translatable_type (locale, job, translation_key, or upload) and translatable_id…
  • GETGet a single pre-translation job/projects/:project_id/pre_translations/:idReturns a single pre-translation job identified by its ID.

Projects

  • GETList projects/projectsList all projects the current user has access to. When the account_id query parameter is omitted, the response includes projects across every account the user…
  • POSTCreate a project/projectsCreate a new project in the given account. When source_project_id is supplied, the new project is created as a clone of that project. All locales, keys, and…
  • GETGet a single project/projects/:idGet details on a single project.
  • DELETEDelete a project/projects/:idDelete an existing project. Associated repository syncs and OTA distributions are removed. A project:delete event is dispatched.
  • PATCHUpdate a project/projects/:idUpdate an existing project, including its review workflow, pre-translation/autotranslate rules, and machine-translation configuration (see workflow,…

Releases

  • GETList releases/accounts/:account_id/distributions/:distribution_id/releasesList all releases for the given distribution.
  • POSTCreate a release/accounts/:account_id/distributions/:distribution_id/releasesCreate a new release.
  • GETGet a single release/accounts/:account_id/distributions/:distribution_id/releases/:idGet details on a single release.
  • DELETEDelete a release/accounts/:account_id/distributions/:distribution_id/releases/:idDelete an existing release.
  • PATCHUpdate a release/accounts/:account_id/distributions/:distribution_id/releases/:idUpdate an existing release.
  • POSTPublish a release/accounts/:account_id/distributions/:distribution_id/releases/:id/publishPublish a release for production.

Release Triggers

  • GETList release triggers/accounts/:account_id/distributions/:distribution_id/release_triggersList all release triggers for the given distribution. Note: Currently only one release trigger can exist per distribution.
  • POSTCreate a release trigger/accounts/:account_id/distributions/:distribution_id/release_triggersCreate a new recurring release. New releases will be published automatically, based on the cron schedule provided. Currently, only one release trigger can…
  • GETGet a single release trigger/accounts/:account_id/distributions/:distribution_id/release_triggers/:idGet details of a single release trigger.
  • DELETEDelete a single release trigger/accounts/:account_id/distributions/:distribution_id/release_triggers/:idDelete a single release trigger.
  • PATCHUpdate a release trigger/accounts/:account_id/distributions/:distribution_id/release_triggers/:idUpdate a recurring release.

Repo Syncs

  • GETGet Repo Syncs/accounts/:account_id/repo_syncsLists all Repo Syncs from an account
  • POSTCreate a Repo Sync/accounts/:account_id/repo_syncsCreate a new Repo Sync.
  • GETGet a single Repo Sync/accounts/:account_id/repo_syncs/:idShows a single Repo Sync setting.
  • PATCHUpdate a repo sync/accounts/:account_id/repo_syncs/:idUpdate settings for an existing Repo Sync. Sending owner_id, export_triggers, or export_schedule requires the caller to have manage_github_sync? permission on…
  • POSTExport to code repository/accounts/:account_id/repo_syncs/:id/exportExport translations from Phrase Strings to repository provider according to the .phrase.yml file within the code repository. *Export is done asynchronously…
  • POSTImport from code repository/accounts/:account_id/repo_syncs/:id/importImport translations from repository provider to Phrase Strings according to the .phrase.yml file within the code repository. _Import is done asynchronously…
  • POSTDeactivate a Repo Sync/accounts/:account_id/repo_syncs/:id/deactivateDeactivate 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.
  • POSTActivate a Repo Sync/accounts/:account_id/repo_syncs/:id/activateActivate a deactivated Repo Sync. Active syncs can be used to import and export translations, and imports to Phrase are automatically triggered by pushes to…

Repo Sync Events

  • GETRepository Syncs History/accounts/:account_id/repo_syncs/:id/eventsGet the history of a single Repo Sync. The history includes all imports and exports performed by the Repo Sync.
  • GETGet a single Repo Sync Event/accounts/:account_id/repo_syncs/:repo_sync_id/events/:idShows a single Repo Sync event.

Reports

  • GETGet Project Report/projects/:project_id/reportGet report of a single project.
  • GETList Locale Reports (word count, character count, translation statistics)/projects/:project_id/report/localesList all locale reports for the given project. Each report includes translation statistics per locale, including word count and character count fields…

Search

  • POSTSearch across projects/accounts/:account_id/searchSearch 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…

Screenshot Markers

  • GETList screenshot markers/projects/:project_id/screenshots/:id/markersList all screenshot markers for the given project.
  • GETGet a single screenshot marker/projects/:project_id/screenshots/:screenshot_id/markers/:idGet details on a single screenshot marker for a given project.
  • POSTCreate a screenshot marker/projects/:project_id/screenshots/:screenshot_id/markersCreate a new screenshot marker.
  • DELETEDelete a screenshot marker/projects/:project_id/screenshots/:screenshot_id/markersDelete an existing screenshot marker.
  • PATCHUpdate a screenshot marker/projects/:project_id/screenshots/:screenshot_id/markersUpdate an existing screenshot marker.

Screenshots

  • GETList screenshots/projects/:project_id/screenshotsList all screenshots for the given project.
  • POSTCreate a screenshot/projects/:project_id/screenshotsCreates a screenshot in a project to provide visual context for in-context translation. Attach translation keys to regions of the uploaded image so…
  • GETGet a single screenshot/projects/:project_id/screenshots/:idReturns a single screenshot belonging to the specified project. Use this to retrieve the screenshot's name, description, hosted image URL, and marker count…
  • DELETEDelete a screenshot/projects/:project_id/screenshots/:idPermanently 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…
  • PATCHUpdate a screenshot/projects/:project_id/screenshots/:idUpdate an existing screenshot.

Spaces

  • GETList Spaces/accounts/:account_id/spacesList all Spaces for the given account.
  • POSTCreate a Space/accounts/:account_id/spacesCreate a new Space.
  • GETGet Space/accounts/:account_id/spaces/:idShow the specified Space.
  • DELETEDelete Space/accounts/:account_id/spaces/:idDelete the specified Space.
  • PATCHUpdate Space/accounts/:account_id/spaces/:idUpdate the specified Space.
  • GETList Projects in Space/accounts/:account_id/spaces/:space_id/projectsList all projects for the specified Space.
  • POSTAdd Project to Space/accounts/:account_id/spaces/:space_id/projectsAdds an existing project to the space.
  • DELETERemove Project from Space/accounts/:account_id/spaces/:space_id/projects/:idRemoves a specified project from the specified space.

Style guides

  • GETList style guides/projects/:project_id/styleguidesList all styleguides for the given project.
  • POSTCreate a style guide/projects/:project_id/styleguidesCreate a new style guide.
  • GETGet a single style guide/projects/:project_id/styleguides/:idGet details on a single style guide.
  • DELETEDelete a style guide/projects/:project_id/styleguides/:idDelete an existing style guide.
  • PATCHUpdate a style guide/projects/:project_id/styleguides/:idUpdate an existing style guide.

Supported Languages

  • GETList supported languages/languagesReturns all languages/locale codes that Phrase Strings recognizes, mapped to their human-readable display name. This endpoint does not require authentication.

Tags

  • GETList tags/projects/:project_id/tagsList all tags for the given project.
  • POSTCreate a tag/projects/:project_id/tagsCreate a new tag.
  • GETGet a single tag/projects/:project_id/tags/:nameGet details and progress information on a single tag for a given project.
  • DELETEDelete a tag/projects/:project_id/tags/:nameDelete an existing tag.

Teams

  • GETList Teams/accounts/:account_id/teamsList all Teams for the given account.
  • POSTCreate a Team/accounts/:account_id/teamsCreate a new Team.
  • GETGet Team/accounts/:account_id/teams/:idShow the specified Team.
  • DELETEDelete Team/accounts/:account_id/teams/:idDelete the specified Team.
  • PATCHUpdate Team/accounts/:account_id/teams/:idUpdate the specified Team.
  • POSTAdd Project to Team/accounts/:account_id/teams/:team_id/projectsAdds an existing project to the team.
  • DELETERemove Project from Team/accounts/:account_id/teams/:team_id/projects/:idRemoves a specified project from the specified team.
  • POSTAdd Space/accounts/:account_id/teams/:team_id/spacesAdds an existing space to the team.
  • DELETERemove Space/accounts/:account_id/teams/:team_id/spaces/:idRemoves a specified space from the specified team.
  • POSTAdd User/accounts/:account_id/teams/:team_id/usersAdds an existing user to the team.
  • DELETERemove User/accounts/:account_id/teams/:team_id/users/:idRemoves a specified user from the specified team.

Translations

  • GETList all translations/projects/:project_id/translationsList translations for the given project. If you want to download all translations for one locale we recommend to use the locales#download endpoint.
  • POSTCreate a translation/projects/:project_id/translationsCreate a translation.
  • GETList translations by locale/projects/:project_id/locales/:locale_id/translationsList translations for a specific locale. If you want to download all translations for one locale we recommend to use the locales#download endpoint.
  • GETList translations by key/projects/:project_id/keys/:key_id/translationsList translations for a specific key.
  • POSTSearch translations/projects/:project_id/translations/searchSearch translations for the given project. Provides the same search interface as translations#index but allows POST requests to avoid limitations imposed by…
  • GETGet a single translation/projects/:project_id/translations/:idGet details on a single translation.
  • PATCHUpdate a translation/projects/:project_id/translations/:idUpdate an existing translation.
  • PATCHVerify a translation/projects/:project_id/translations/:id/verifyVerify an existing translation.
  • PATCHMark a translation as unverified/projects/:project_id/translations/:id/unverifyMark an existing translation as unverified.
  • PATCHReview a translation/projects/:project_id/translations/:id/reviewMark an existing translation as reviewed.
  • PATCHUnreview a translation/projects/:project_id/translations/:id/unreviewMark a reviewed translation as translated.
  • PATCHExclude a translation from export/projects/:project_id/translations/:id/excludeSet exclude from export flag on an existing translation.
  • PATCHInclude a translation/projects/:project_id/translations/:id/includeRemove exclude from export flag from an existing translation.
  • PATCHVerify translations by query/projects/:project_id/translations/verifyVerify translations matching query.
  • PATCHUnverify translations by query/projects/:project_id/translations/unverifyMark translations matching query as unverified. To unverify the translations of specific keys, filter by key id (and optionally locale) directly, for example…
  • PATCHReview translations selected by query/projects/:project_id/translations/reviewReview translations matching query.
  • PATCHUnreview translations selected by query/projects/:project_id/translations/unreviewUnreview translations matching query.
  • PATCHExclude translations by query/projects/:project_id/translations/excludeExclude translations matching query from locale export.
  • PATCHInclude translations by query/projects/:project_id/translations/includeInclude translations matching query in locale export.

Uploads

  • GETList uploads/projects/:project_id/uploadsList all uploads for the given project.
  • POSTUpload a new file/projects/:project_id/uploadsUpload a new language file. Creates necessary resources in your project. The upload is processed asynchronously: this endpoint returns 201 Created once the…
  • GETGet a single upload/projects/:project_id/uploads/:idView details and summary for a single upload. Use this endpoint to poll for the outcome of an upload created via POST /projects/{project_id}/uploads — check…

Users

  • GETShow current User/userShow details for current User.

Variables

  • GETList variables/projects/:project_id/variablesList all variables for the current project.
  • POSTCreate a variable/projects/:project_id/variablesCreate a new variable.
  • GETGet a single variable/projects/:project_id/variables/:nameGet details on a single variable for a given project.
  • DELETEDelete a variable/projects/:project_id/variables/:nameDelete an existing variable.
  • PATCHUpdate a variable/projects/:project_id/variables/:nameUpdate an existing variable.

Versions / History

  • GETList all versions/projects/:project_id/translations/:translation_id/versionsList all changes done to a given translation.
  • GETGet a single version/projects/:project_id/translations/:translation_id/versions/:idGet details on a single version.

Webhooks

  • GETList webhooks/projects/:project_id/webhooksList all webhooks for the given project.
  • POSTCreate a webhook/projects/:project_id/webhooksCreate a new webhook.
  • GETGet a single webhook/projects/:project_id/webhooks/:idGet details on a single webhook.
  • DELETEDelete a webhook/projects/:project_id/webhooks/:idDelete an existing webhook.
  • PATCHUpdate a webhook/projects/:project_id/webhooks/:idUpdate an existing webhook.
  • POSTTest a webhook/projects/:project_id/webhooks/:id/testPerform a test request for a webhook. Sends a synthetic test:event payload to the webhook's callback_url and returns the webhook resource.

Webhook Deliveries

  • GETList webhook deliveries/projects/:project_id/webhooks/:webhook_id/deliveriesList all webhook deliveries for the given webhook_id.
  • GETGet a single webhook delivery/projects/:project_id/webhooks/:webhook_id/deliveries/:idGet all information about a single webhook delivery for the given ID.
  • POSTRedeliver a single webhook delivery/projects/:project_id/webhooks/:webhook_id/deliveries/:id/redeliverTrigger an individual webhook delivery to be redelivered.

Figma attachments

  • GETList Figma attachments/projects/:project_id/figma_attachmentsList all Figma attachments for the given project
  • POSTCreate a Figma attachment/projects/:project_id/figma_attachmentsCreate a new Figma attachment.
  • GETGet a single Figma attachment/projects/:project_id/figma_attachments/:idGet details on a single Figma attachment for a given project.
  • DELETEDelete a Figma attachment/projects/:project_id/figma_attachments/:idDelete an existing Figma attachment.
  • PATCHUpdate a Figma attachment/projects/:project_id/figma_attachments/:idUpdate an existing Figma attachment.

Key's Figma attachments

  • POSTAttach the Figma attachment to a key/projects/:project_id/figma_attachments/:figma_attachment_id/keysAttach the Figma attachment to a key
  • DELETEDetach the Figma attachment from a key/projects/:project_id/figma_attachments/:figma_attachment_id/keys/:idDetach the Figma attachment from a key

Upload Batches

  • POSTCreate upload batch/projects/:project_id/upload_batchesGroups multiple file uploads into a single batch. Optionally, launches the deletion of unmentioned translation keys after all uploads in the batch are…

Quality performance score

  • POSTGet Translation Quality/projects/:project_id/quality_performance_scoreRetrieves the quality scores for your Strings translations. Returns a score, measured by Phrase QPS

Automations

  • GETList automations/accounts/:account_id/automationsList all automations for an account. For feature availability, see Jobs (Strings).
  • POSTCreate an automation/accounts/:account_id/automationsCreate a new automation. For feature availability, see Jobs (Strings).
  • GETGet a single automation/accounts/:account_id/automations/:automation_idGet details of a single automation. For feature availability, see Jobs (Strings).
  • DELETEDestroy automation/accounts/:account_id/automations/:automation_idDestroy an automation of an account. For feature availability, see Jobs (Strings).
  • PATCHUpdate an automation/accounts/:account_id/automations/:automation_idUpdate an existing automation. For feature availability, see Jobs (Strings).
  • POSTActivate an automation/accounts/:account_id/automations/:automation_id/activateActivate an automation. For feature availability, see Jobs (Strings).

Showing 300 of 302 endpoints. Fork the collection to see all of them.

API details

Base URL
https://api.phrase.com/v2
https://api.us.app.phrase.com/v2
Authentication
An API key in the Authorization header
HTTP Basic authentication (username and password)
Operations
302 operations on 184 pathsGET 113POST 75PATCH 64DELETE 50
Main resources
Translations 19Jobs 13Keys 11Teams 11Branches 9Automations 8Comments 8Job Locales 8Repo Syncs 8Spaces 8
Response formats
application/json *
Description format
OpenAPI 3.0.3, API version 2.0.0

How to test the Phrase Strings API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Phrase Strings API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses an API key in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “List accounts” (GET /accounts), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Phrase Strings API?

Phrase Strings is a translation management platform for software projects. You can collaborate on language file translation with your team or order… It is listed under Developer tools and has 302 endpoints.

Who publishes the Phrase Strings API?

It is listed from Phrase's public API description (an OpenAPI document), not published by Phrase on Swastik Codes. Anyone who controls phrase.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Phrase Strings API?

Its description lists 2 base URLs: https://api.phrase.com/v2, https://api.us.app.phrase.com/v2. The first is the usual one; the others are typically sandbox or regional servers.

How do I authenticate with the Phrase Strings API?

It accepts 2 methods: an API key in the Authorization header; HTTP Basic authentication (username and password).

How many endpoints does the Phrase Strings API have?

302 operations on 184 paths (113 GET, 75 POST, 64 PATCH, 50 DELETE). The largest groups are Translations, Jobs, Keys, Teams.

Is forking the Phrase Strings API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.