Activate a Repo Sync
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.
Phrase Strings provides APIs for software localization projects, locales, keys, translations, files, jobs, and automation.
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.
Activate an automation. For feature availability, see Jobs (Strings).
Adds a target locale to a job.
Add multiple keys to a existing job.
Adds an existing project to the space.
Adds an existing project to the team.
Adds an existing space to the team.
Tags all keys matching query. Same constraints as list.
Adds an existing user to the team.
Attach the Figma attachment to a key
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. Use this when you need to detach specific child keys from a shared translation source, or to fully break apart a linked-key group so each key manages its own translations independently. When child keys are unlinked, their translations are updated with a copy of the parent's current content (strategy keep_content, the default) or cleared (strategy remove_content). This operation is only available on main projects. It returns 422 when a child key in `child_key_ids` is not currently linked to the parent, or when a translation update fails while unlinking.
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 ordinal forms — adjusted to the pluralization rules of each requested locale. Use this endpoint to normalize translation templates before importing them into locale files, or to validate that a source string carries the plural forms required by a target language. Either `content` or `id` must be provided — supplying both or neither returns 400. When `id` is used and the referenced translation does not exist, the endpoint returns 404. When the source string is not valid ICU message format syntax, the endpoint returns 422 with an `error` field describing the parse failure.
Cancel an existing order. Must not yet be confirmed.
Check if comment was marked as read. Returns 204 if read, 404 if unread.
Compare branch with main branch. *Note: Comparing a branch may take several minutes depending on the project size. Consider using the `POST /compare` endpoint for creating comparison asynchronously.*
Mark a job as completed.
Mark a job locale as completed.
Confirm an existing order and send it to the provider for translation. Same constraints as for create.
Create a new blocked-key rule.
Create a new branch. Branch project provisioning runs asynchronously, so the newly created branch is returned in a transitional state (typically `creating_branch`) and only reaches `success` once the underlying project has been set up. Poll the branch resource until its `state` becomes `success` before performing further operations on it. Requires the Branching feature to be enabled on the account. *Note: Creating a new branch may take several minutes depending on the project size.*
Create a new comment for a key.
Create a new distribution.
Create a new Figma attachment.
Create a new job.
Create a new comment for a job.
Create a new job template.
Create a new job template locale.
Creates a locale-pair-specific machine translation provider override for the account. When a mapping exists for a given source/target locale pair, that provider is used instead of the account default. Only one mapping may exist per source/target locale pair; attempting to create a duplicate returns a validation error. The source and target locale codes must differ.
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`.
Create a new order. Access token scope must include `orders.create`.
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). Enqueues machine translation using the project's configured MT engine.
Create a new custom metadata property.
Create a new reaction for a comment.
Create a new release.
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.
Create a new reply for a comment.
Create a new Repo Sync.
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. This endpoint accepts a multipart/form-data request with a binary file upload, unlike most Phrase API endpoints that use JSON. Use a multipart form client or the -F flag in curl rather than a JSON body. The screenshot name must be unique within the project (case-insensitive). When name is omitted, it is derived from the uploaded filename. The account must have the Screenshots feature enabled; requests to projects on accounts without it return 403. Creating a screenshot requires a token with the write scope and manage access to the project.
Create a new screenshot marker.
Create a new Space.
Create a new style guide.
Create a new tag.
Create a new Team.
Create a new term in a term base (previously: glossary).
Create a new term base (previously: glossary).
Create a new translation for a term in a term base (previously: glossary).
Create a new variable.
Create a webhook with an optional unique signing key used by the receiver to verify webhook signatures. Omitting it uses the Phrase project's default signing key.
Create a new authorization. This operation requires Basic authentication with email and password and is unavailable on this API-key toolkit.
Create a new automation. For feature availability, see Jobs (Strings).
Create a new organization job template.
Create a new organization job template locale.
Create a branch comparison asynchronously.
Create a translation key in a Phrase Strings project with the documented key attributes, optionally including default-locale content.
Add a locale to a Phrase Strings project using a unique locale-style name and an ISO locale code.
Create a Phrase Strings localization project in an accessible account. With source_project_id, Phrase asynchronously clones locales, keys, translations, and source settings after responding; explicit settings override inherited settings except shares_translation_memory. Without cloning, shares_translation_memory defaults to true.
Create content for one key and locale in a Phrase Strings project.
Groups multiple file uploads into a single batch. Optionally, launches the deletion of unmentioned translation keys after all uploads in the batch are completed.
Create or update an annotation for a job. If the annotation already exists, it will be updated; otherwise, a new annotation will be created.
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.
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.
Deactivate an automation. For feature availability, see Jobs (Strings).
Delete an existing blocked-key rule.
Delete 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 the request is rejected with `409 Conflict`. A branch whose current `state` does not allow deletion (for example, while a merge or sync is in progress) is rejected with `422 Unprocessable Entity`. Requires the Branching feature to be enabled on the account.
Delete an existing comment.
Delete an existing distribution.
Delete an existing Figma attachment.
Delete an existing job.
Delete an annotation for a job.
Delete an existing job comment.
Delete an annotation for a job locale.
Delete an existing job template.
Delete an existing job template locale.
Removes the machine translation provider override for the specified source and target locale pair. The mapping is identified by locale codes supplied as query parameters rather than a path ID.
Delete an existing reaction.
Delete an existing release.
Delete an existing reply.
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-region marker linked to it are destroyed together and cannot be recovered.
Delete an existing screenshot marker.
Delete a single release trigger.
Delete an existing style guide.
Delete an existing tag.
Delete an existing term in a term base (previously: glossary).
Delete an existing term base (previously: glossary).
Delete an existing translation of a term in a term base (previously: glossary).
Delete an existing variable.
Delete an existing webhook.
Delete an existing authorization. API calls using that token will stop working. This operation requires Basic authentication with email and password and is unavailable on this API-key toolkit.
Delete an existing invitation (must not be accepted yet). Access token scope must include `team.manage`.
Delete an existing organization job template.
Delete an existing organization job template locale.
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.
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.
Delete an existing Phrase Strings key from a project or project branch.
Delete an explicitly selected locale from a Phrase Strings project or project branch.
Delete an explicitly selected Phrase Strings project. Phrase also removes associated repository syncs and OTA distributions and dispatches a project:delete event.
Delete the specified Space.
Delete the specified Team.
Destroy an automation of an account. For feature availability, see Jobs (Strings).
Destroy a custom metadata property of an account. This endpoint is only available to accounts with advanced plans or above.
Detach the Figma attachment from a key
**Note:** 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 active check issues.
Download a locale in a specific file format.
Exclude a locale on keys matching query. Same constraints as list.
Set exclude from export flag on an existing translation.
Exclude translations matching query from locale export.
Export translations from Phrase Strings to repository provider according to the .phrase.yml file within the code repository. *Export is done asynchronously and may take several seconds depending on the project size.*
Get a single blocked-key rule.
Get details on a single account.
Get details on a single authorization. This operation requires Basic authentication with email and password and is unavailable on this API-key toolkit.
Get details of a single automation. For feature availability, see Jobs (Strings).
Get details on a single branch for a given project. Requires the Branching feature to be enabled on the account.
Get details on a single comment.
Get details on a single distribution.
Get details on a single Figma attachment for a given project.
Get details on a single invitation. Access token scope must include `team.manage`.
Get details on a single job for a given project.
Get details on a single job comment.
Get details on a single job template for a given project.
Get a single job template locale for a given job template.
Get details on a single key for a given project.
Get details on a single locale for a given project.
Get details on a single notification.
Get details on a single order.
Get details on a single organization job template for a given account.
Get a single job template locale for a given organization job template.
Returns a single pre-translation job identified by its ID.
Get details on a single project.
Get details of a single custom property.
Get details on a single reaction.
Get details on a single release.
Get details of a single release trigger.
Get details on a single reply.
Shows a single Repo Sync setting.
Shows a single Repo Sync event.
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 the same record without side effects. The Attachable Screenshots feature must be enabled on the account.
Get details on a single screenshot marker for a given project.
Get details on a single style guide.
Get details and progress information on a single tag for a given project.
Get details for a single term in the term base (previously: glossary).
Get details on a single term base (previously: glossary).
Get details on a single translation.
View 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 the `state` field.
Get details on a single variable for a given project.
Get details on a single version.
Get details on a single webhook.
Get all information about a single webhook delivery for the given ID.
Return the Phrase Strings user represented by the connected access token.
Returns the machine translation configuration for the account, including the default translation service, current machine translation unit usage, and any locale-pair-specific provider mappings.
Get report of a single project.
Lists all Repo Syncs from an account
Get details on a single user in the account. Access token scope must include `team.manage`.
Show the specified Space.
Show the specified Team.
Retrieves the quality scores for your Strings translations. Returns a score, measured by Phrase QPS
Import translations from repository provider to Phrase Strings according to the .phrase.yml file within the code repository. _Import is done asynchronously and may take several seconds depending on the project size._
Include a locale on keys matching query. Same constraints as list.
Remove exclude from export flag from an existing translation.
Include translations matching query in locale export.
Prepare a locale for download in a specific file format.
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 short label and its long-form variant — so translators see them in context together. Pass an empty child_key_ids array to mark the key as a parent without linking any children yet. Both the parent key and every child key must belong to the main project; branch keys cannot participate in key links. A child key can have at most one parent at a time; attempting to link a child that already has a parent returns a 422 error with code CHILD_IS_ALREADY_LINKED. Parent and child key plurality must match — linking a plural child to a non-plural parent (or vice versa) also returns a 422.
List all jobs for the given account.
List Phrase Strings accounts available to the connected user and return account IDs for project creation and filtering.
List translations for the given project. If you want to download all translations for one locale we recommend to use the `locales#download` endpoint.
List all changes done to a given translation.
List all your authorizations. This operation requires Basic authentication with email and password and is unavailable on this API-key toolkit.
Returns 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 `project_ids` to narrow by project. For feature availability, see Jobs (Strings).
List all automations for an account. For feature availability, see Jobs (Strings).
List all blocked-key rules for the given project.
List all branches of the current project. Requires the Branching feature to be enabled on the account.
**Note:** 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 locale, check name, and state.
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 auditing translation consistency across related keys. The key identified by `id` must be designated as a parent key (it must have at least one child key linked to it). Listing the links of a key that is not a parent returns 400.
List all comments for a key.
List all distributions for the given account.
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. Use this endpoint to enumerate documents before downloading, previewing, or triggering translation workflows for individual files. The q parameter performs a prefix match on the document name (case-insensitive). For example, passing q=invoice returns documents whose names begin with "invoice" but not documents containing "invoice" elsewhere in the name.
Returns the run history for a specific automation, newest-first. For feature availability, see Jobs (Strings).
List all Figma attachments for the given project
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. Results are limited to 1,000 entries.
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 endpoint does not require authentication and is not subject to rate limiting.
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`.
Retrieve a list of annotations for a job.
List all comments for a job.
Retrieve a list of annotations for a job locale.
List all target locales for a given job.
List all job template locales for a given job template.
List all job templates for the given project.
List all jobs for the given project.
List all keys for the given project. Alternatively you can POST requests to /search.
List all locale reports for the given project. Each report includes translation statistics per locale, including word count and character count fields (`source_word_count`, `word_count`, `word_count_unverified`, `word_count_missing`) as well as translation completion statistics (`keys_count`, `completed_translations_count`, `untranslated_keys_count`, `unverified_translations_count`, `reviewed_translations_count`, and their percentages). Use the `tag` parameter to scope the report to a specific job (e.g. its job tag) to get job-scoped word count statistics.
List or filter locales in a Phrase Strings project and return locale IDs used by translation actions.
List all locales unique by locale code used across all projects within an account.
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`.
List all notification groups from the current user
List all notifications from the current user
List all orders for the given project.
List all job template locales for a given organization job template.
List all job templates for the given account.
Returns all pre-translation jobs scoped to a project, ordered by creation date descending.
Get all members active in the project. Access token scope must include `read`.
List or search Phrase Strings projects available to the connected user, optionally within one account or limited to favorites.
List all projects for the specified Space.
List all custom metadata properties for an account. This endpoint is only available to accounts with advanced plans or above.
List all reactions for a comment.
List all release triggers for the given distribution. Note: Currently only one release trigger can exist per distribution.
List all releases for the given distribution.
List all replies for a comment.
List all screenshot markers for the given project.
List all screenshots for the given project.
List all Spaces for the given account.
List all styleguides for the given project.
Returns all languages/locale codes that Phrase Strings recognizes, mapped to their human-readable display name. This endpoint does not require authentication.
List all tags for the given project.
List all Teams for the given account.
List all term bases (previously: glossaries) the current user has access to.
List all terms in term bases (previously: glossary) that the current user has access to.
List translations for a specific key.
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 all uploads for the given project.
List all variables for the current project.
List all webhook deliveries for the given webhook_id.
List all webhooks for the given project.
If you are the job owner, you may lock a job using this API request.
Mark a comment as read.
Mark a comment as unread.
Mark a notifications group of the current user as read
Mark a reply as read.
Mark a reply as unread.
Mark an existing translation as unverified.
Mark all notification groups of the current user as read
Mark all notifications of the current user as read
Merge an existing branch back into its base branch. The merge runs asynchronously. The branch transitions to `merging_branch` and settles in `merged`, `merge_error`, or `merge_conflict` once the background job completes; the response body for this request is empty. Poll the branch resource to observe the final state. A branch cannot be merged while it still has open jobs or open translation orders attached to its branch project — in that case the request is rejected with `409 Conflict`. A branch whose current `state` does not allow a merge is rejected with `422 Unprocessable Entity`. Requires the Branching feature to be enabled on the account. *Note: Merging a branch may take several minutes depending on diff size.*
Publish a release for production.
Trigger an individual webhook delivery to be redelivered.
Removes a target locale from a job.
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`.
Remove multiple keys from existing job.
Removes a specified project from the specified space.
Removes a specified project from the specified team.
Removes a specified space from the specified team.
Removes specified tags from keys matching query.
Removes a specified user from the specified team.
Mark a job as uncompleted.
Mark a job locale as uncompleted.
Get the history of a single Repo Sync. The history includes all imports and exports performed by the Repo Sync.
Resend the invitation email (must not be accepted yet). Access token scope must include `team.manage`.
Mark job locale as reviewed.
Mark an existing translation as reviewed.
Review translations matching query.
Search for keys and translations in all account projects *Note: Search is limited to 10000 results and may not include recently updated data depending on the project sizes.*
Search translation keys in a Phrase Strings project by text or documented qualifiers such as name:, ids:, tags:, or translated:.
Search translations in a Phrase Strings project and return each match with its key and locale context. Results are capped at 10,000 and may lag recent updates in large projects. To download every translation for one locale, use Phrase's locale-download endpoint instead.
Get a single target locale for a given job.
Show status of already started async locale download. If the download is finished, the download link will be returned.
Starts an existing job in state draft.
Pull changes from the base branch into this branch, applying the chosen conflict-resolution strategy. The sync runs asynchronously. The branch transitions to `syncing_branch` and settles back into `success` (or `merge_conflict` / `branch_error`) once the background job completes; the response body for this request is empty. Poll the branch resource to observe the final state. Only branches created with the newer branching system can be synced. Requests against branches from the older system, or against branches whose current state does not allow a sync, are rejected with `422 Unprocessable Entity` and an empty body. Requires the Branching feature to be enabled on the account.
Perform a test request for a webhook. Sends a synthetic `test:event` payload to the webhook's `callback_url` and returns the webhook resource.
Trigger an automation.
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 independent — its existing translations are updated with the parent's current content and then marked unverified, signalling that reviewers should confirm the content is still appropriate for the child's context. Use this endpoint when you need to detach one specific child key while keeping other children linked. To detach multiple children at once, use the batch unlink endpoint. This operation is only available on main projects. It returns 422 when the child key is not currently linked to the specified parent key, or when a translation update fails during the unlink process.
If you are the job owner, you may unlock a locked job using this API request.
Mark a reviewed translation as translated.
Unreview translations matching query.
Mark translations matching query as unverified. To unverify the translations of specific keys, filter by key id (and optionally locale) directly, for example `key.id:KEY_ID_1,KEY_ID_2 locale.id:LOCALE_ID`. There is no need to look up translation ids first.
Update an existing blocked-key rule.
Update an existing branch. Only the branch name can be changed. Requires the Branching feature to be enabled on the account.
Update an existing comment.
Update an existing distribution.
Update an existing Figma attachment.
Update an existing job.
Update an existing job comment.
Update an existing job target locale.
Update an existing job template.
Update an existing job template locale.
Update an existing locale.
Update user permissions in the account. Developers and translators need `project_ids` and `locale_ids` assigned to access them. To grant account-wide language access instead of access scoped to specific projects, use `default_locale_codes`. Access token scope must include `team.manage`.
Update member's settings in the invitations. Access token scope must include `team.manage`.
Update user settings in the project. Access token scope must include `team.manage`.
Update an existing project, including its review workflow, pre-translation/autotranslate rules, and machine-translation configuration (see workflow, machine_translation_enabled, and the autotranslate_* fields below).
Update an existing custom metadata property.
Update an existing release.
Update a recurring release.
Update settings for an existing Repo Sync. Sending `owner_id`, `export_triggers`, or `export_schedule` requires the caller to have `manage_github_sync?` permission on the project (returns `403` otherwise). Sending `export_triggers` or `export_schedule` when the automatic export feature is not enabled for the account returns `422`.
Update an existing screenshot.
Update an existing screenshot marker.
Update an existing style guide.
Update an existing term in a term base (previously: glossary).
Update an existing term base (previously: glossary).
Update an existing translation for a term in a term base (previously: glossary).
Update an existing variable.
Update an existing webhook, optionally rotating its unique signing key used by the receiver to verify webhook signatures.
Update an existing authorization. This operation requires Basic authentication with email and password and is unavailable on this API-key toolkit.
Update an existing automation. For feature availability, see Jobs (Strings).
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`.
Update an existing organization job template.
Update an existing organization job template locale.
Update the documented attributes of one Phrase Strings translation key; omitted fields remain unchanged.
Sets the default machine translation service for the account. Requires write access to the account's machine translation settings. Passing an empty or absent value for `default_service` resets the account to its plan default (Microsoft Translate).
Update the specified Space.
Update the specified Team.
Update the content or reversible workflow state of one Phrase Strings translation.
Upload a new language file. Creates necessary resources in your project. The upload is processed asynchronously: this endpoint returns `201 Created` once the file has been accepted and enqueued, not once processing has finished. Poll `GET /projects/{project_id}/uploads/{id}` and check the `state` field — `error` means processing failed (for example, an unparseable file or a `file_format` that doesn't match the file's actual content). Note: be aware of upload limits.
Verify an existing translation.
Verify translations matching query.
The Phrase integration connects your Dench AI CRM directly to Phrase, so agents can read and act on your Phrase data as part of everyday work — answering questions in chat, keeping your CRM in sync, and running automations without anyone copying data between tools.
302 actions are available for agents to invoke on your behalf. Every call runs through Phrase's own authorization, scoped to the account you connect.
Sign in to your Dench workspace and open Integrations.
Find Phrase and click Connect — you'll authorize access through Phrase's own sign-in flow. No API keys or code required.
Ask an agent to use Phrase in chat, or call it from an automation.
Manage or disconnect the connection any time from workspace settings.
The Dench Phrase integration connects your AI CRM to Phrase, so AI agents can work with your Phrase data as part of chats, automations, and CRM workflows. You connect your account once, and every agent in your workspace can use it — governed by your workspace permissions.
The Phrase integration currently exposes 302 actions, including Activate a Repo Sync, Activate an automation, Add a target locale to a job, Add keys to job, Add Project to Space, and Add Project to Team. Agents invoke them on your behalf from chat or from automations.
No. You connect Phrase from your Dench workspace using Phrase's own sign-in and authorization flow — no API keys to copy, no glue code to maintain.
Connections are authorized through Phrase's own authentication flow, and Dench stores only the authorization needed to act on your behalf. You can review and disconnect the Phrase connection from your workspace settings at any time.