# Phrase Developer Hub: English API Reference TMS V1 API Documentation ## API Documentation - [English / API Reference / TMS / V1 / API Documentation / Job (48 pages)](https://developers.phrase.com/_llms/en/api-reference/tms/v1/api-documentation/job.md): Documentation for English / API Reference / TMS / V1 / API Documentation / Job. - [English / API Reference / TMS / V1 / API Documentation / Project (60 pages)](https://developers.phrase.com/_llms/en/api-reference/tms/v1/api-documentation/project.md): Documentation for English / API Reference / TMS / V1 / API Documentation / Project. ### Additional Workflow Step - [List additional workflow steps](https://developers.phrase.com/en/api/tms/v1/additional-workflow-step/list-additional-workflow-steps.md): Accessible to ADMIN and PROJECT_MANAGER roles. - [Create additional workflow step](https://developers.phrase.com/en/api/tms/v1/additional-workflow-step/create-additional-workflow-step.md): Requires ADMIN or PROJECT_MANAGER role with the setup-server access right. The name must be unique within the organization. - [Delete additional workflow step](https://developers.phrase.com/en/api/tms/v1/additional-workflow-step/delete-additional-workflow-step.md): Requires ADMIN or PROJECT_MANAGER role with the setup-server access right. ### Analysis - [Create analysis](https://developers.phrase.com/en/api/tms/v1/analysis/create-analysis.md): Deprecated. Use 'Create analyses by providers' (byProviders) or 'Create analyses by languages' (byLanguages) instead. Requires the CREATE analysis right (internal users). - [Edit analyses (batch)](https://developers.phrase.com/en/api/tms/v1/analysis/edit-analyses-batch.md): Deprecated. Use v2 'Edit analyses (batch)' (PUT /api2/v2/analyses/bulk) instead. Requires the EDIT analysis right (internal users). - [Delete analyses (batch)](https://developers.phrase.com/en/api/tms/v1/analysis/delete-analyses-batch.md): When purge is true the analyses are permanently (hard) deleted. Requires the DELETE analysis right (internal users). - [Create analyses by languages](https://developers.phrase.com/en/api/tms/v1/analysis/create-analyses-by-languages.md): Creates one analysis per target language (analyzeByLanguage) for the supplied jobs. Requires the CREATE analysis right (internal users). - [Create analyses by providers](https://developers.phrase.com/en/api/tms/v1/analysis/create-analyses-by-providers.md): Creates one analysis per provider (analyzeByLinguist) for the supplied jobs. Requires the CREATE analysis right (internal users). - [Recalculate analysis](https://developers.phrase.com/en/api/tms/v1/analysis/recalculate-analysis.md): Requires the RECALCULATE analysis right (internal users). - [Get analysis](https://developers.phrase.com/en/api/tms/v1/analysis/get-analysis.md): Deprecated. Use v3 'Get analysis' (GET /api2/v3/analyses/{analyseUid}) instead. - [Delete analysis](https://developers.phrase.com/en/api/tms/v1/analysis/delete-analysis.md): When purge is true the analysis is permanently (hard) deleted. Requires the DELETE analysis right (internal users). - [Get analysis language part](https://developers.phrase.com/en/api/tms/v1/analysis/get-analysis-language-part.md): Returns analysis language pair - [List jobs of analyses](https://developers.phrase.com/en/api/tms/v1/analysis/list-jobs-of-analyses.md): Returns list of job's analyses - [Download analysis](https://developers.phrase.com/en/api/tms/v1/analysis/download-analysis.md): Requires the DOWNLOAD analysis right (internal or linguist users). - [Get jobs analysis](https://developers.phrase.com/en/api/tms/v1/analysis/get-jobs-analysis.md): Returns job's analyse - [Set or remove net rate scheme for analyse](https://developers.phrase.com/en/api/tms/v1/analysis/set-or-remove-net-rate-scheme-for-analyse.md): Sets the net rate scheme of the analysis. A null netRateScheme removes the currently associated scheme. Requires the EDIT analysis right (internal users). - [List analyses](https://developers.phrase.com/en/api/tms/v1/analysis/list-analyses.md) ### Async Request - [List pending requests](https://developers.phrase.com/en/api/tms/v1/async-request/list-pending-requests.md): API call to return a list of pending asynchronous requests. - [Get current limits](https://developers.phrase.com/en/api/tms/v1/async-request/get-current-limits.md) - [Get asynchronous request](https://developers.phrase.com/en/api/tms/v1/async-request/get-asynchronous-request.md): This API call will return information about the specified [asynchronous request](https://support.phrase.com/hc/en-us/articles/5709706916124-API-TMS-#asynchronous-apis-0-2). ### Authentication - [Login](https://developers.phrase.com/en/api/tms/v1/authentication/login.md): Deprecated. Use the v3 login endpoint (POST /api2/v3/auth/login) instead.

 

The login may be rejected when the organization restricts authentication to SSO login and API token SSO enforcement is enabled for the organization. - [Login as another user](https://developers.phrase.com/en/api/tms/v1/authentication/login-as-another-user.md): Deprecated. Use the v3 login as another user endpoint (POST /api2/v3/auth/loginOther) instead.

 

Available only for admin. Only the owner of an account may log into accounts that belong to multiple platform organizations. - [Login to session](https://developers.phrase.com/en/api/tms/v1/authentication/login-to-session.md): Deprecated. Use the v3 login to session endpoint (POST /api2/v3/auth/loginToSession) instead.

 

Logs the user into a browser session and returns a session cookie and CSRF token rather than an API token. The login is rejected when the organization restricts authentication to SSO login. - [Login with Apple with code](https://developers.phrase.com/en/api/tms/v1/authentication/login-with-apple-with-code.md) - [Login with Apple refresh token](https://developers.phrase.com/en/api/tms/v1/authentication/login-with-apple-refresh-token.md) - [Login with Google](https://developers.phrase.com/en/api/tms/v1/authentication/login-with-google.md) - [Logout](https://developers.phrase.com/en/api/tms/v1/authentication/logout.md): The API token may be supplied either via the token query parameter or the Authorization header, but not both. - [Refresh Apple token](https://developers.phrase.com/en/api/tms/v1/authentication/refresh-apple-token.md): Validates the supplied Apple refresh token and returns a refreshed Apple token response. - [Who am I](https://developers.phrase.com/en/api/tms/v1/authentication/who-am-i.md): Returns the currently authenticated user (the current user), including their role, username, and account details. Use this endpoint to find out who the current logged-in user is, check my role, retrieve my user profile, or look up the authenticated user. Also answers "who am I" for the logged-in use… ### Automations - [List automated project creation settings](https://developers.phrase.com/en/api/tms/v1/automations/list-automated-project-creation-settings.md) - [Delete automated project settings in batch](https://developers.phrase.com/en/api/tms/v1/automations/delete-automated-project-settings-in-batch.md): Deletes all automated project creation (APC) settings listed in `automatedProjectIds` and returns `204 No Content`. - [Delete automated project settings](https://developers.phrase.com/en/api/tms/v1/automations/delete-automated-project-settings.md): Deletes the automated project creation (APC) settings identified by `settingsId` and returns `204 No Content`. - [Check remote service status for automated project settings](https://developers.phrase.com/en/api/tms/v1/automations/check-remote-service-status-for-automated-project-settings.md): For a legacy APC, once the migration deadline has passed this endpoint responds with `403 Forbidden`. - [Call force import for automated project settings](https://developers.phrase.com/en/api/tms/v1/automations/call-force-import-for-automated-project-settings.md): For a legacy APC, once the migration deadline has passed this endpoint responds with `403 Forbidden`. - [Returns files from monitored folder](https://developers.phrase.com/en/api/tms/v1/automations/returns-files-from-monitored-folder.md): Available only for APCs stored on the Automation Service; otherwise the request fails with `400 Bad Request`. - [Get Automated Project Creation running state](https://developers.phrase.com/en/api/tms/v1/automations/get-automated-project-creation-running-state.md): Available only for APCs stored on the Automation Service; otherwise the request fails with `400 Bad Request`. - [Get Automated Project Creation status data](https://developers.phrase.com/en/api/tms/v1/automations/get-automated-project-creation-status-data.md): Returns the current status of the automated project creation (APC) identified by `settingsId`, including its last/next check times, associated projects, monitored folder statuses, and any active `warnings`. ### Business Unit - [List business units](https://developers.phrase.com/en/api/tms/v1/business-unit/list-business-units.md): Only available when the Business Units feature is enabled for the organization. - [Create business unit](https://developers.phrase.com/en/api/tms/v1/business-unit/create-business-unit.md): Only available when the Business Units feature is enabled for the organization. Requires the setupServer access right. Business unit names must be unique within the organization. - [Get business unit](https://developers.phrase.com/en/api/tms/v1/business-unit/get-business-unit.md): Only available when the Business Units feature is enabled for the organization. Requires the setupServer access right. - [Edit business unit](https://developers.phrase.com/en/api/tms/v1/business-unit/edit-business-unit.md) - [Delete business unit](https://developers.phrase.com/en/api/tms/v1/business-unit/delete-business-unit.md): Deleting a business unit clears its reference from all projects, project templates, term bases, and translation memories. ### Buyer - [List buyers](https://developers.phrase.com/en/api/tms/v1/buyer/list-buyers.md) - [Edit buyer](https://developers.phrase.com/en/api/tms/v1/buyer/edit-buyer.md): Changing the default project owner updates all project templates owned by the previous owner within this buyer's vendor organization to use the new owner. ### Client - [List clients](https://developers.phrase.com/en/api/tms/v1/client/list-clients.md): Project managers without the clientViewOther right see only clients they created. - [Create client](https://developers.phrase.com/en/api/tms/v1/client/create-client.md): Requires the clientCreate access right for project managers. Client names must be unique within the organization. - [Get client](https://developers.phrase.com/en/api/tms/v1/client/get-client.md): Project managers who did not create the client need the clientViewOther access right (default off) to view it. - [Edit client](https://developers.phrase.com/en/api/tms/v1/client/edit-client.md): Sending null for priceList or netRateScheme clears the existing association. Project managers who did not create the client need the clientEditOther access right (default off) to edit it. - [Delete client](https://developers.phrase.com/en/api/tms/v1/client/delete-client.md): Deleting a client also removes its contacts and business units, and clears the client reference from all projects, project templates, term bases, and translation memories. Project managers who did not create the client need the clientDeleteOther access right (default off) to delete it. ### Connector - [Get Connector async task states.](https://developers.phrase.com/en/api/tms/v1/connector/get-connector-async-task-states.md): Returns a page of connector async task states for the given project. When dateCreatedFrom/dateCreatedTo are not provided, the dateCreated window defaults to the last 24 hours (current time minus 24h) up to current time plus 1h. - [Get connectors' authentication page url](https://developers.phrase.com/en/api/tms/v1/connector/get-connectors-authentication-page-url.md) - [List connectors](https://developers.phrase.com/en/api/tms/v1/connector/list-connectors.md): Connectors of a sunsetted type are excluded from the response and from totalCount. Requires ADMIN, PROJECT_MANAGER, LINGUIST, or SUBMITTER role. - [Create connector](https://developers.phrase.com/en/api/tms/v1/connector/create-connector.md): Creates a connector of the specified type. A connection test is run automatically for MAGENTO and TYPO3 connector types, or whenever `connectionTest=true` is passed. For OAuth-based connectors (e.g. GitHub, GitLab, Google Drive, OneDrive), complete the three-step OAuth flow first: POST /connectorAut… - [Store connector oAuth code](https://developers.phrase.com/en/api/tms/v1/connector/store-connector-oauth-code.md): Step 2 of 3 in the OAuth connector flow. Stores the authorization code returned by the OAuth provider. Provide the `state` token from POST /connectorAuthData and the `code` from the OAuth callback. Returns 200 if the code was stored successfully, 400 if the state token is invalid or expired. Require… - [Retrieve connector oAuth code](https://developers.phrase.com/en/api/tms/v1/connector/retrieve-connector-oauth-code.md): Step 3 of 3 in the OAuth connector flow. Polls for the authorization code stored by POST /connectorAuthCode. Use the `state` token from POST /connectorAuthData as the `code` path parameter. `cancelled` is true if the user cancelled the OAuth flow. `code` is null until the OAuth provider has redirect… - [Generate connector oAuth state](https://developers.phrase.com/en/api/tms/v1/connector/generate-connector-oauth-state.md): Step 1 of 3 in the OAuth connector flow. Generates a one-time state token (returned as `state`). Pass this token to the connector's OAuth authorization URL, then call POST /connectorAuthCode with the returned code. Required for OAuth-based connector types (e.g. GitHub, GitLab, Google Drive, OneDrive… - [Test connection of existing connector.](https://developers.phrase.com/en/api/tms/v1/connector/test-connection-of-existing-connector.md): Test connection for provided connector id. Requires ADMIN, PROJECT_MANAGER, LINGUIST, or SUBMITTER role. - [Get a connector](https://developers.phrase.com/en/api/tms/v1/connector/get-a-connector.md): Requires ADMIN, PROJECT_MANAGER, LINGUIST, or SUBMITTER role. - [Edit connector](https://developers.phrase.com/en/api/tms/v1/connector/edit-connector.md): Replaces all connector credentials. Use PATCH for partial updates. A connection test is run for MAGENTO and TYPO3 connector types, or when `connectionTest=true` is passed. Requires ADMIN or PROJECT_MANAGER role with the Connector setup access right. - [Delete connector](https://developers.phrase.com/en/api/tms/v1/connector/delete-connector.md): Deletes the connector and its backend credentials. All job widget associations are removed. Requires ADMIN or PROJECT_MANAGER role with the Connector setup access right. Fails with a Bad Request response if the connector is still used in automated project creation settings. - [Patch connector](https://developers.phrase.com/en/api/tms/v1/connector/patch-connector.md): Partially updates connector credentials. Only fields included in the request body are changed. The connector type cannot be changed; a type mismatch returns 400. A connection test is run for MAGENTO and TYPO3 connector types, or when `connectionTest=true` is passed. Requires ADMIN or PROJECT_MANAGER… - [List files in root](https://developers.phrase.com/en/api/tms/v1/connector/list-files-in-root.md): List files in a root folder of the selected connector. Requires ADMIN, PROJECT_MANAGER, LINGUIST, or SUBMITTER role. - [List files in a subfolder](https://developers.phrase.com/en/api/tms/v1/connector/list-files-in-a-subfolder.md): List files in a subfolder of the selected connector. Requires ADMIN, PROJECT_MANAGER, LINGUIST, or SUBMITTER role. - [Upload a file to a subfolder of the selected connector](https://developers.phrase.com/en/api/tms/v1/connector/upload-a-file-to-a-subfolder-of-the-selected-connector.md): Upload a file to a subfolder of the selected connector - [Download file](https://developers.phrase.com/en/api/tms/v1/connector/download-file.md): Download a file from a subfolder of the selected connector. Requires ADMIN, PROJECT_MANAGER, LINGUIST, or SUBMITTER role. ### Conversations - [Find all conversation](https://developers.phrase.com/en/api/tms/v1/conversations/find-all-conversation.md): Returns conversations of all types across the requested jobs. Available to internal, guest and linguist users. Project managers require the EDIT right on the job; other roles require SHOW. Guests must also match the project client and have the right to view other users' projects. - [Search conversation by project](https://developers.phrase.com/en/api/tms/v1/conversations/search-conversation-by-project.md): This endpoint is allowed only to PM and ADMIN roles. - [List all conversations](https://developers.phrase.com/en/api/tms/v1/conversations/list-all-conversations.md): Returns conversations of all types for the given job. Available to internal, guest and linguist users. Project managers require the EDIT right on the job; other roles require SHOW. Guests must also match the project client and have the right to view other users' projects. - [List LQA conversations](https://developers.phrase.com/en/api/tms/v1/conversations/list-lqa-conversations.md): Available to internal, guest and linguist users; project managers require the EDIT right on the job, other roles require SHOW, and guests must also match the project client and have the right to view other users' projects. - [Get LQA conversation](https://developers.phrase.com/en/api/tms/v1/conversations/get-lqa-conversation.md): Available to internal, guest and linguist users. Project managers require the EDIT right on the job; other roles require SHOW. Guests must also match the project client and have the right to view other users' projects. - [Edit LQA conversation](https://developers.phrase.com/en/api/tms/v1/conversations/edit-lqa-conversation.md): Deprecated: use PUT /api2/v2/jobs/{jobUid}/conversations/lqas/{conversationId} (updateLqaConversationV2) instead. This v1 endpoint does not support changing the LQA description. Available to internal, guest and linguist users; project managers require the EDIT right on the job, other roles require S… - [Delete LQA conversation](https://developers.phrase.com/en/api/tms/v1/conversations/delete-lqa-conversation.md): Flags the LQA conversation as deleted. Available to internal, guest and linguist users; project managers require the EDIT right on the job, other roles require SHOW, and guests must also match the project client and have the right to view other users' projects. - [Add LQA comment](https://developers.phrase.com/en/api/tms/v1/conversations/add-lqa-comment.md): Deprecated: use POST /api2/v2/jobs/{jobUid}/conversations/lqas/{conversationId}/comments (addLQACommentV2) instead. This v1 endpoint returns only the conversation, whereas v2 returns a result wrapper containing the new comment id. Available to internal, guest and linguist users; project managers req… - [Edit LQA comment](https://developers.phrase.com/en/api/tms/v1/conversations/edit-lqa-comment.md): Deprecated: use PUT /api2/v2/jobs/{jobUid}/conversations/lqas/{conversationId}/comments/{commentId} (updateLQACommentV2) instead. Available to internal, guest and linguist users; project managers require the EDIT right on the job, other roles require SHOW, and guests must also match the project clie… - [Delete LQA comment](https://developers.phrase.com/en/api/tms/v1/conversations/delete-lqa-comment.md): Available to internal, guest and linguist users; project managers require the EDIT right on the job, other roles require SHOW, and guests must also match the project client and have the right to view other users' projects. - [List plain conversations](https://developers.phrase.com/en/api/tms/v1/conversations/list-plain-conversations.md): Available to internal, guest and linguist users; project managers require the EDIT right on the job, other roles require SHOW, and guests must also match the project client and have the right to view other users' projects. - [Create plain conversation](https://developers.phrase.com/en/api/tms/v1/conversations/create-plain-conversation.md): Deprecated: use POST /api2/v3/jobs/{jobUid}/conversations/plains (createSegmentTargetConversationV3) instead. Available to internal, guest and linguist users; project managers require the EDIT right on the job, other roles require SHOW, and guests must also match the project client and have the righ… - [Get plain conversation](https://developers.phrase.com/en/api/tms/v1/conversations/get-plain-conversation.md): Available to internal, guest and linguist users; project managers require the EDIT right on the job, other roles require SHOW, and guests must also match the project client and have the right to view other users' projects. - [Edit plain conversation](https://developers.phrase.com/en/api/tms/v1/conversations/edit-plain-conversation.md): Available to internal, guest and linguist users; project managers require the EDIT right on the job, other roles require SHOW, and guests must also match the project client and have the right to view other users' projects. - [Delete plain conversation](https://developers.phrase.com/en/api/tms/v1/conversations/delete-plain-conversation.md): Flags the plain conversation as deleted. Available to internal, guest and linguist users; project managers require the EDIT right on the job, other roles require SHOW, and guests must also match the project client and have the right to view other users' projects. - [Add plain comment](https://developers.phrase.com/en/api/tms/v1/conversations/add-plain-comment.md): Deprecated: use POST /api2/v3/jobs/{jobUid}/conversations/plains/{conversationId}/comments (addPlainCommentV3) instead. This v1 endpoint returns only the conversation, whereas v3 returns a result wrapper containing the new comment id. Available to internal, guest and linguist users; project managers… - [Edit plain comment](https://developers.phrase.com/en/api/tms/v1/conversations/edit-plain-comment.md): Deprecated: use PUT /api2/v3/jobs/{jobUid}/conversations/plains/{conversationId}/comments/{commentId} (updatePlainCommentV3) instead. Available to internal, guest and linguist users; project managers require the EDIT right on the job, other roles require SHOW, and guests must also match the project… - [Delete plain comment](https://developers.phrase.com/en/api/tms/v1/conversations/delete-plain-comment.md): Available to internal, guest and linguist users; project managers require the EDIT right on the job, other roles require SHOW, and guests must also match the project client and have the right to view other users' projects. ### Cost Center - [List of cost centers](https://developers.phrase.com/en/api/tms/v1/cost-center/list-of-cost-centers.md): Accessible only by users with the ADMIN or PROJECT_MANAGER role. Results are scoped to the caller's organization. The `name` filter uses prefix matching. - [Create cost center](https://developers.phrase.com/en/api/tms/v1/cost-center/create-cost-center.md): Requires ADMIN or PROJECT_MANAGER role with the "Setup server" access right. The `name` field is mandatory. - [Get cost center](https://developers.phrase.com/en/api/tms/v1/cost-center/get-cost-center.md) - [Edit cost center](https://developers.phrase.com/en/api/tms/v1/cost-center/edit-cost-center.md): Only non-null fields in the request body are applied (partial update). Requires ADMIN or PROJECT_MANAGER role with the "Setup server" access right. - [Delete cost center](https://developers.phrase.com/en/api/tms/v1/cost-center/delete-cost-center.md): Soft-deletes the cost center and removes its association from any Project, ProjectTemplate, ProjectFilter, and ProjectTemplateFilter. Requires ADMIN or PROJECT_MANAGER role with the "Setup server" access right. ### Custom Fields - [Lists custom fields](https://developers.phrase.com/en/api/tms/v1/custom-fields/lists-custom-fields.md): Returns a paginated list of custom fields for the organization. - [Create custom field](https://developers.phrase.com/en/api/tms/v1/custom-fields/create-custom-field.md): Creates a new custom field for the organization. - [Get custom field](https://developers.phrase.com/en/api/tms/v1/custom-fields/get-custom-field.md) - [Edit custom field](https://developers.phrase.com/en/api/tms/v1/custom-fields/edit-custom-field.md): Updates an existing custom field. - [Delete custom field](https://developers.phrase.com/en/api/tms/v1/custom-fields/delete-custom-field.md) - [Lists options of custom field](https://developers.phrase.com/en/api/tms/v1/custom-fields/lists-options-of-custom-field.md): Returns a paginated list of all options of the given custom field. - [Deprecate custom field option](https://developers.phrase.com/en/api/tms/v1/custom-fields/deprecate-custom-field-option.md): Deprecates or reactivates a single option of a `SINGLE_SELECT` or `MULTI_SELECT` custom field. - [List TB custom fields](https://developers.phrase.com/en/api/tms/v1/custom-fields/list-tb-custom-fields.md) - [Create TB custom field](https://developers.phrase.com/en/api/tms/v1/custom-fields/create-tb-custom-field.md) - [Delete TB custom field](https://developers.phrase.com/en/api/tms/v1/custom-fields/delete-tb-custom-field.md) - [Edit TB custom field](https://developers.phrase.com/en/api/tms/v1/custom-fields/edit-tb-custom-field.md) ### Custom File Type - [Get all custom file types](https://developers.phrase.com/en/api/tms/v1/custom-file-type/get-all-custom-file-types.md): The `supportsContinuousJob` flag of each item is derived from the file type. - [Create custom file type](https://developers.phrase.com/en/api/tms/v1/custom-file-type/create-custom-file-type.md): The `type` field accepts only the following values: html, json, xml, multiling_xml, txt. - [Delete multiple custom file types](https://developers.phrase.com/en/api/tms/v1/custom-file-type/delete-multiple-custom-file-types.md): Returns 501 Not Implemented when custom file types are not enabled for the organization. - [Find custom file type](https://developers.phrase.com/en/api/tms/v1/custom-file-type/find-custom-file-type.md): Finds the custom file type whose filename pattern matches the given `fileName`. If no matching custom file type is found it returns status 200 and an empty body. - [Get custom file type](https://developers.phrase.com/en/api/tms/v1/custom-file-type/get-custom-file-type.md): The response `supportsContinuousJob` flag is derived from the file type. - [Update custom file type](https://developers.phrase.com/en/api/tms/v1/custom-file-type/update-custom-file-type.md): The `type` field accepts only the following values: html, json, xml, multiling_xml, txt. - [Delete custom file type](https://developers.phrase.com/en/api/tms/v1/custom-file-type/delete-custom-file-type.md): Returns 501 Not Implemented when custom file types are not enabled for the organization. ### Domain - [List of domains](https://developers.phrase.com/en/api/tms/v1/domain/list-of-domains.md): Returns domains belonging to the caller's organisation. Domain is the org-configurable field used to tag/categorize content type (e.g. Marketing, Legal, Medical, Technical) on projects, project templates, translation memories, and term bases. Results are role-dependent: LINGUIST, SUBMITTER, and GUES… - [Create domain](https://developers.phrase.com/en/api/tms/v1/domain/create-domain.md): Domain name must be unique within the organisation. - [Get domain](https://developers.phrase.com/en/api/tms/v1/domain/get-domain.md): Project managers who did not create the domain need the clientViewOther access right (default off) to view it. - [Edit domain](https://developers.phrase.com/en/api/tms/v1/domain/edit-domain.md): Name must be unique within the organisation if provided. Pass null to leave it unchanged. Project managers who did not create the domain need the clientEditOther access right (default off) to edit it. - [Delete domain](https://developers.phrase.com/en/api/tms/v1/domain/delete-domain.md): Deletes the domain and removes its reference from all projects, project templates, translation memories, and term bases. Also removes all user and vendor domain assignments. Project managers who did not create the domain need the clientDeleteOther access right (default off) to delete it. ### Due Date Scheme - [List due date schemes](https://developers.phrase.com/en/api/tms/v1/due-date-scheme/list-due-date-schemes.md) - [Create due date scheme](https://developers.phrase.com/en/api/tms/v1/due-date-scheme/create-due-date-scheme.md) - [Delete due date schemes (batch)](https://developers.phrase.com/en/api/tms/v1/due-date-scheme/delete-due-date-schemes-batch.md) - [Get due date scheme](https://developers.phrase.com/en/api/tms/v1/due-date-scheme/get-due-date-scheme.md) - [Edit due date scheme](https://developers.phrase.com/en/api/tms/v1/due-date-scheme/edit-due-date-scheme.md): Replaces the whole due date scheme - fields left out are reset to their default value. ### Email Template - [List email templates](https://developers.phrase.com/en/api/tms/v1/email-template/list-email-templates.md): Requires an internal user role (Admin or Project Manager). To duplicate/clone an existing template, look up its fields here or via the get-single-template endpoint, then submit them (with a new name) to the create-email-template endpoint. - [Create (or duplicate/clone) email template](https://developers.phrase.com/en/api/tms/v1/email-template/create-or-duplicateclone-email-template.md): Requires an internal user role (Admin or Project Manager) with the Setup server access right. Also used to duplicate/clone an existing template: fetch the source template via list/get, then resubmit its fields here (typically with a new name). - [Send test email](https://developers.phrase.com/en/api/tms/v1/email-template/send-test-email.md): Sends a test email with the given subject and body to the currently authenticated user, to preview formatting/macros before creating or updating a stored template. Available to any authenticated user (including BOT/service-account users); no specific role is required. Does not reference an existing… - [Get email template types](https://developers.phrase.com/en/api/tms/v1/email-template/get-email-template-types.md): Requires an internal user role (Admin or Project Manager). Returns the allowed values for the type field/filter used by the other email template endpoints. - [Get email template](https://developers.phrase.com/en/api/tms/v1/email-template/get-email-template.md): Requires an internal user role (Admin or Project Manager). To duplicate/clone this template under a new name, submit its returned fields to the create-email-template endpoint. - [Update email template](https://developers.phrase.com/en/api/tms/v1/email-template/update-email-template.md): Requires an internal user role (Admin or Project Manager) with the Setup server access right. Replaces all editable fields of the template; it is a full update, not a partial patch — omitted optional fields (ccAddress/bccAddress) are cleared. - [Delete email template](https://developers.phrase.com/en/api/tms/v1/email-template/delete-email-template.md): Requires an internal user role (Admin or Project Manager) with the Setup server access right. ### File - [List files](https://developers.phrase.com/en/api/tms/v1/file/list-files.md) - [Upload file](https://developers.phrase.com/en/api/tms/v1/file/upload-file.md): Accepts multipart/form-data, application/octet-stream or application/json. - [Get file](https://developers.phrase.com/en/api/tms/v1/file/get-file.md): Get uploaded file as octet-stream or as json based on 'Accept' header - [Delete file](https://developers.phrase.com/en/api/tms/v1/file/delete-file.md) ### Glossary - [List glossaries](https://developers.phrase.com/en/api/tms/v1/glossary/list-glossaries.md): Term content for a glossary (create/get/update/delete term, browse/search, import, export, metadata) is managed at /api2/v1/termBases/{termBaseUid}, passing the glossary UID as termBaseUid — Glossary and TermBase are sibling resource types, and the polymorphic termBases content endpoints accept a gl… - [Create glossary](https://developers.phrase.com/en/api/tms/v1/glossary/create-glossary.md): Available to internal users only (Admin or Project Manager). Term content for a glossary (create/get/update/delete term, browse/search, import, export, metadata) is managed at /api2/v1/termBases/{termBaseUid}, passing the glossary UID as termBaseUid — Glossary and TermBase are sibling resource types… - [Get glossary](https://developers.phrase.com/en/api/tms/v1/glossary/get-glossary.md): Term content for a glossary (create/get/update/delete term, browse/search, import, export, metadata) is managed at /api2/v1/termBases/{termBaseUid}, passing the glossary UID as termBaseUid — Glossary and TermBase are sibling resource types, and the polymorphic termBases content endpoints accept a gl… - [Edit glossary](https://developers.phrase.com/en/api/tms/v1/glossary/edit-glossary.md): Languages can only be added, their removal is not supported. The glossary owner must be an Admin or Project Manager. Term content for a glossary (create/get/update/delete term, browse/search, import, export, metadata) is managed at /api2/v1/termBases/{termBaseUid}, passing the glossary UID as termBa… - [Delete glossary](https://developers.phrase.com/en/api/tms/v1/glossary/delete-glossary.md): When purge is false the glossary is soft-deleted; unlike term bases, glossaries do not appear in the deleted-resources recycle bin, so there is currently no way to restore one. When purge is true the glossary is permanently deleted and cannot be restored. Term content for a glossary (create/get/upda… - [Activate/Deactivate glossary](https://developers.phrase.com/en/api/tms/v1/glossary/activatedeactivate-glossary.md): Activates the glossary when active is true and deactivates it when active is false. - [Export glossary](https://developers.phrase.com/en/api/tms/v1/glossary/export-glossary.md): This API endpoint is still limited access, and only available to customers on the Enterprise plans on request. Please contact support or your customer success manager if you are interested. - [Purge glossary](https://developers.phrase.com/en/api/tms/v1/glossary/purge-glossary.md): This API endpoint is still limited access, and only available to customers on the Enterprise plans on request. Please contact support or your customer success manager if you are interested. - [Upload glossary](https://developers.phrase.com/en/api/tms/v1/glossary/upload-glossary.md): This API endpoint is still limited access, and only available to customers on the Enterprise plans on request. Please contact support or your customer success manager if you are interested. ### Import settings - [List import settings](https://developers.phrase.com/en/api/tms/v1/import-settings/list-import-settings.md): Accessible to internal roles (Admin, Project Manager); other roles receive 403. - [Edit import settings](https://developers.phrase.com/en/api/tms/v1/import-settings/edit-import-settings.md): The import settings to update are resolved by the uid in the request body. Requires an internal role (Admin or Project Manager) with the access-settings right to set up the server. - [Create import settings](https://developers.phrase.com/en/api/tms/v1/import-settings/create-import-settings.md): Pre-defined import settings is handy for [Create Job](../job/create-job) and [Create project template](../project-template/create-project-template). See [supported file types](https://support.phrase.com/hc/en-us/articles/5709698419868-File-Type-L… - [Get organization's default import settings](https://developers.phrase.com/en/api/tms/v1/import-settings/get-organizations-default-import-settings.md): Returns the import settings configured as the default for the organization. - [Edit organization's default import settings](https://developers.phrase.com/en/api/tms/v1/import-settings/edit-organizations-default-import-settings.md): Updates the import settings configured as the default for the organization. Requires an internal role (Admin or Project Manager) with the access-settings right to set up the server. - [Get import settings](https://developers.phrase.com/en/api/tms/v1/import-settings/get-import-settings.md) - [Delete import settings](https://developers.phrase.com/en/api/tms/v1/import-settings/delete-import-settings.md) ### Language AI - [List of Language AI profiles](https://developers.phrase.com/en/api/tms/v1/language-ai/list-of-language-ai-profiles.md): Deprecated. Use the v2 list profiles endpoint (GET /api2/v2/memsourceTranslateProfiles) instead. ### Language Assets - [Search language assets](https://developers.phrase.com/en/api/tms/v1/language-assets/search-language-assets.md): Search across term bases and translation memories for matching language assets. ### Language Quality Assessment - [Start multiple LQA Assessments](https://developers.phrase.com/en/api/tms/v1/language-quality-assessment/start-multiple-lqa-assessments.md): Starts LQA assessments for the given job parts. If any of them have the assessment already started or finished, they are left unchanged. - [Get multiple LQA Assessments](https://developers.phrase.com/en/api/tms/v1/language-quality-assessment/get-multiple-lqa-assessments.md): Returns Assessment results for given jobs. If any given job is not from LQA workflow step, result from successive workflow steps may be returned - [Discard multiple ongoing LQA Assessments](https://developers.phrase.com/en/api/tms/v1/language-quality-assessment/discard-multiple-ongoing-lqa-assessments.md): Discards ongoing Language Quality Assessment (LQA) assessments for the given job parts in a single request. An assessment must be in the ongoing (started) state to be discarded; assessments that have not been started are silently skipped — no error is returned for them. Discarding is irreversible: d… - [Edit multiple LQA assessments](https://developers.phrase.com/en/api/tms/v1/language-quality-assessment/edit-multiple-lqa-assessments.md): Marks assessments for the given as edited - [Download LQA Assessment XLSX reports](https://developers.phrase.com/en/api/tms/v1/language-quality-assessment/download-lqa-assessment-xlsx-reports.md): Use this endpoint to export completed Language Quality Assessment (LQA) results as XLSX files for offline review, auditing, or integration with external quality management tools. Each XLSX report corresponds to one job part that has passed through an LQA workflow step in Phrase TMS. - [Send email(s) with LQA reports](https://developers.phrase.com/en/api/tms/v1/language-quality-assessment/send-emails-with-lqa-reports.md): Sends LQA (Language Quality Assessment) report emails to one or more recipients for the specified job parts. Use this to notify reviewers or project stakeholders when assessments are complete and the report is ready for review. - [Get sharable link of LQA reports](https://developers.phrase.com/en/api/tms/v1/language-quality-assessment/get-sharable-link-of-lqa-reports.md): Returns exactly one time-limited download link covering all the supplied job parts — never one link per job part. The link resolves to a single XLSX when the request contains exactly one job part, or a single ZIP archive (one XLSX per job part) when it contains more than one. - [Get recipients of email with LQA reports](https://developers.phrase.com/en/api/tms/v1/language-quality-assessment/get-recipients-of-email-with-lqa-reports.md) - [Get LQA Assessment results](https://developers.phrase.com/en/api/tms/v1/language-quality-assessment/get-lqa-assessment-results.md): Returns Language Quality Assessment (LQA) scoring results for one or more job parts. Each result includes the score as a percentage (0–100), a PASS or FAIL verdict based on the project's configured LQA threshold, and a breakdown of issue counts by severity. Use this endpoint after assessments have b… - [Finish multiple LQA Assessments](https://developers.phrase.com/en/api/tms/v1/language-quality-assessment/finish-multiple-lqa-assessments.md): Finishing LQA Assessments will calculate scores - [Discard multiple finished LQA Assessment results](https://developers.phrase.com/en/api/tms/v1/language-quality-assessment/discard-multiple-finished-lqa-assessment-results.md) - [Get LQA Assessment](https://developers.phrase.com/en/api/tms/v1/language-quality-assessment/get-lqa-assessment.md): Retrieves the Language Quality Assessment (LQA) status and results for a single job. Use this endpoint after a reviewer finishes an LQA workflow step to read the MQM (Multidimensional Quality Metrics)-based score, issue counts by severity, and the pass/fail determination before advancing the job to… - [Start LQA Assessment](https://developers.phrase.com/en/api/tms/v1/language-quality-assessment/start-lqa-assessment.md): Starts a Language Quality Assessment (LQA) for a single job part identified by its unique identifier (UID). LQA evaluates translation quality against the profile assigned to the job part's workflow step, scoring errors by category and severity in line with MQM (Multidimensional Quality Metrics) meth… - [Discard ongoing LQA Assessment](https://developers.phrase.com/en/api/tms/v1/language-quality-assessment/discard-ongoing-lqa-assessment.md): Discards the in-progress Language Quality Assessment (LQA) for the specified job, removing all recorded issues and resetting the assessment state. Use this when an assessment was started in error or needs to be restarted from scratch. - [Finish LQA Assessment](https://developers.phrase.com/en/api/tms/v1/language-quality-assessment/finish-lqa-assessment.md): Finishing LQA Assessment will calculate score - [Run Auto LQA](https://developers.phrase.com/en/api/tms/v1/language-quality-assessment/run-auto-lqa.md): Runs Auto LQA either for job parts listed in `jobParts` or for all job parts in the given `projectWorkflowStep`. Both fields are mutually exclusive. If the project has no steps, then all job parts in the project accessible to the user are u… ### Machine Translation - [Translate with MT](https://developers.phrase.com/en/api/tms/v1/machine-translation/translate-with-mt.md): Sends one or more source strings to the machine translation (MT) engine identified by the MT settings UID and returns the translated strings in the same order as the input. This call is synchronous — the response contains the translations directly, not a job reference. ### Machine Translation Settings - [List machine translate settings](https://developers.phrase.com/en/api/tms/v1/machine-translation-settings/list-machine-translate-settings.md): Accessible to project managers without the 'Modify Server Setup' right. - [Create new machine translate settings](https://developers.phrase.com/en/api/tms/v1/machine-translation-settings/create-new-machine-translate-settings.md): To add required secrets for each type use endpoint - [Set up secrets](#operation/setUpMachineTranslateSettingsSecrets) - [List third party machine translate settings](https://developers.phrase.com/en/api/tms/v1/machine-translation-settings/list-third-party-machine-translate-settings.md): Accessible to project managers without the 'Modify Server Setup' right. - [Get machine translate settings types](https://developers.phrase.com/en/api/tms/v1/machine-translation-settings/get-machine-translate-settings-types.md): Returns valid type strings for POST /machineTranslateSettings (e.g. GoogleTranslate, AMAZON). Call this before creating a new MT engine to discover supported types. Accessible to project managers without the 'Modify Server Setup' right. - [Get machine translate settings](https://developers.phrase.com/en/api/tms/v1/machine-translation-settings/get-machine-translate-settings.md): Accessible to project managers without the 'Modify Server Setup' right. - [Update machine translate settings](https://developers.phrase.com/en/api/tms/v1/machine-translation-settings/update-machine-translate-settings.md): You can update existing settings ONLY with settings with the same type. It is forbidden to change type of settings using this API operation. - [Delete machine translate settings](https://developers.phrase.com/en/api/tms/v1/machine-translation-settings/delete-machine-translate-settings.md): Deletion is a no-op for Language AI profile wrapper engines (MemsourceTranslateSettings); the request succeeds with 204 but no data is removed. - [Get machine Google AutoML labels](https://developers.phrase.com/en/api/tms/v1/machine-translation-settings/get-machine-google-automl-labels.md) - [Set up Google AutoML labels](https://developers.phrase.com/en/api/tms/v1/machine-translation-settings/set-up-google-automl-labels.md) - [Get machine translate settings secrets](https://developers.phrase.com/en/api/tms/v1/machine-translation-settings/get-machine-translate-settings-secrets.md) - [Set up machine translate settings secrets](https://developers.phrase.com/en/api/tms/v1/machine-translation-settings/set-up-machine-translate-settings-secrets.md): It is possible to only add secrets to existing settings with corresponding secrets type e.g it is possible to add only Amazon specific secrets to the Amazon type settings. - [Upload service account key for Google AutoML](https://developers.phrase.com/en/api/tms/v1/machine-translation-settings/upload-service-account-key-for-google-automl.md): For file in the request body provide also the filename in Content-Disposition header. - [Get status of machine translate engine](https://developers.phrase.com/en/api/tms/v1/machine-translation-settings/get-status-of-machine-translate-engine.md) ### Mapping - [Returns mapping for taskId (mxliff)](https://developers.phrase.com/en/api/tms/v1/mapping/returns-mapping-for-taskid-mxliff.md): Requires view right on the Job. workflowLevel defaults to 1 (range 1-15). ### Net Rate Scheme - [List net rate schemes](https://developers.phrase.com/en/api/tms/v1/net-rate-scheme/list-net-rate-schemes.md): Returns a paged list of net rate scheme references for the caller's organization, ordered by creation date (newest first) by default; a saved per-user list sort, when present, takes precedence. Optional query parameters filter the result set. Requires an internal role (Admin or Project Manager). - [Create net rate scheme](https://developers.phrase.com/en/api/tms/v1/net-rate-scheme/create-net-rate-scheme.md): Deprecated. Use the v2 create net rate scheme endpoint (POST /api2/v2/netRateSchemes) instead. Creates a net rate scheme for the caller's organization. When defaultScheme is true the scheme becomes the organization default and any previous default is unset. Requires an internal role (Admin or Projec… - [Get net rate scheme](https://developers.phrase.com/en/api/tms/v1/net-rate-scheme/get-net-rate-scheme.md): Deprecated. Use the v2 get net rate scheme endpoint (GET /api2/v2/netRateSchemes/{netRateSchemeUid}) instead. Returns the net rate scheme identified by its UID, including the default (workflow-step independent) rates. Non-translatable (NT) rate fields are returned as zero when the organization editi… - [Edit net rate scheme](https://developers.phrase.com/en/api/tms/v1/net-rate-scheme/edit-net-rate-scheme.md): Deprecated. Use the v2 edit net rate scheme endpoint (PUT /api2/v2/netRateSchemes/{netRateSchemeUid}) instead. Updates the net rate scheme identified by its UID, replacing its name and default flag. When rates is supplied, the default (workflow-step independent) rates are replaced; when rates is omi… - [Delete net rate scheme](https://developers.phrase.com/en/api/tms/v1/net-rate-scheme/delete-net-rate-scheme.md): Deletes the net rate scheme identified by its UID. Requires an internal role (Admin or Project Manager) with the setup-server right; the scheme must belong to the caller's organization. - [Clone net rate scheme](https://developers.phrase.com/en/api/tms/v1/net-rate-scheme/clone-net-rate-scheme.md): Creates a copy of the net rate scheme identified by its UID, including all of its workflow-step rate settings. The clone is never marked as the organization default. Returns 200 (not 201) because the created DTO is returned directly. Non-translatable (NT) rate fields are returned as zero when the or… - [List schemes for workflow step](https://developers.phrase.com/en/api/tms/v1/net-rate-scheme/list-schemes-for-workflow-step.md): Returns a paged list of the workflow-step rate references of the given net rate scheme. Requires an internal role (Admin or Project Manager); the scheme must belong to the caller's organization. - [Get scheme for workflow step](https://developers.phrase.com/en/api/tms/v1/net-rate-scheme/get-scheme-for-workflow-step.md): Returns the workflow-step-specific rates of the given net rate scheme. Non-translatable (NT) rate fields are returned as zero when the organization edition does not include the non-translatables-in-analyses feature. Requires an internal role (Admin or Project Manager) with the setup-server right; th… - [Edit scheme for workflow step](https://developers.phrase.com/en/api/tms/v1/net-rate-scheme/edit-scheme-for-workflow-step.md): Updates the workflow-step-specific rates of the given net rate scheme. Non-translatable (NT) rate fields are returned as zero when the organization edition does not include the non-translatables-in-analyses feature. Requires an internal role (Admin or Project Manager) with the setup-server right; th… ### Notifications - [List notifications](https://developers.phrase.com/en/api/tms/v1/notifications/list-notifications.md): Returns notifications scoped to the currently authenticated user. Results are paginated and sorted by date created (DATE_CREATED). The response includes a responseTimestamp. Authentication is required; unauthenticated requests are rejected with 403 Forbidden. ### Price List - [List price lists](https://developers.phrase.com/en/api/tms/v1/price-list/list-price-lists.md) - [Create price list](https://developers.phrase.com/en/api/tms/v1/price-list/create-price-list.md): If isDefault is set to true, the default flag is cleared on all other price lists. - [Export translation price list template](https://developers.phrase.com/en/api/tms/v1/price-list/export-translation-price-list-template.md): Returns an empty price list template as a binary XLSX file. - [Get price list](https://developers.phrase.com/en/api/tms/v1/price-list/get-price-list.md) - [Update price list](https://developers.phrase.com/en/api/tms/v1/price-list/update-price-list.md): If isDefault is set to true, the default flag is cleared on all other price lists. - [Delete price list](https://developers.phrase.com/en/api/tms/v1/price-list/delete-price-list.md) - [Clone price list](https://developers.phrase.com/en/api/tms/v1/price-list/clone-price-list.md) - [Export translation price list](https://developers.phrase.com/en/api/tms/v1/price-list/export-translation-price-list.md): Returns the price list as a binary XLSX file. - [Import translation price list](https://developers.phrase.com/en/api/tms/v1/price-list/import-translation-price-list.md): Returns a parsed preview with per-row validation errors. Prices are not persisted. - [List price sets](https://developers.phrase.com/en/api/tms/v1/price-list/list-price-sets.md) - [Add language pairs](https://developers.phrase.com/en/api/tms/v1/price-list/add-language-pairs.md) - [Remove language pairs](https://developers.phrase.com/en/api/tms/v1/price-list/remove-language-pairs.md) - [Edit minimum prices](https://developers.phrase.com/en/api/tms/v1/price-list/edit-minimum-prices.md): Applies the minimum price to all language pairs for the given source and target language filters. - [Edit prices](https://developers.phrase.com/en/api/tms/v1/price-list/edit-prices.md): If object contains only price, all languages and workflow steps will be updated. - [Remove language pair](https://developers.phrase.com/en/api/tms/v1/price-list/remove-language-pair.md) ### Project Template - [List project templates](https://developers.phrase.com/en/api/tms/v1/project-template/list-project-templates.md): API call to list [project templates](https://support.phrase.com/hc/en-us/articles/5709647439772-Project-Templates-TMS-). - [Create project template](https://developers.phrase.com/en/api/tms/v1/project-template/create-project-template.md): Creates a project template by copying the settings of an existing project referenced by `project.uid`. The source language, target languages, and workflow steps of that project are inherited by the new template and returned in the response — they cannot be set directly in this request. - [Get project template, including who is assigned and provider assignments per workflow step](https://developers.phrase.com/en/api/tms/v1/project-template/get-project-template-including-who-is-assigned-and-provider-assignments-per-workflow-step.md): Returns current provider/assignee data for the template: `assignedTo` (per-target-language provider assignments, used when the template has no workflow steps) and `workflowSettings` (per-workflow-step provider assignments and settings, used when the template has workflow steps). - [Edit project template](https://developers.phrase.com/en/api/tms/v1/project-template/edit-project-template.md): Replaces all editable fields of the project template in a single call. - [Delete project template](https://developers.phrase.com/en/api/tms/v1/project-template/delete-project-template.md) - [Patch project template](https://developers.phrase.com/en/api/tms/v1/project-template/patch-project-template.md): Partially updates a project template. Only the fields present in the request body are updated; omitted fields retain their current values. - [Get project template access and security settings](https://developers.phrase.com/en/api/tms/v1/project-template/get-project-template-access-and-security-settings.md) - [Edit project template access and security settings](https://developers.phrase.com/en/api/tms/v1/project-template/edit-project-template-access-and-security-settings.md) - [Get analyse settings](https://developers.phrase.com/en/api/tms/v1/project-template/get-analyse-settings.md) - [Edit analyse settings](https://developers.phrase.com/en/api/tms/v1/project-template/edit-analyse-settings.md) - [Clone project template](https://developers.phrase.com/en/api/tms/v1/project-template/clone-project-template.md): Creates a copy of a project template. All settings are cloned: source and target languages, workflow steps, translation memory and term base assignments, pre-translate settings, security settings, and custom fields. The cloned template receives a new unique identifier. - [Get content group for project template](https://developers.phrase.com/en/api/tms/v1/project-template/get-content-group-for-project-template.md): Returns the content group linked to the project template. Returns an empty response body if the template has no content group linked. - [Set project template content group](https://developers.phrase.com/en/api/tms/v1/project-template/set-project-template-content-group.md): Sets the content group for the project template, replacing any previously linked group. Returns the newly linked content group. Returns 422 Unprocessable Entity if the project template already has style guides assigned. - [Unlink project template from content group](https://developers.phrase.com/en/api/tms/v1/project-template/unlink-project-template-from-content-group.md): Idempotent — if the project template has no content group linked, returns 204 No Content without error. - [Get custom fields of project template (page)](https://developers.phrase.com/en/api/tms/v1/project-template/get-custom-fields-of-project-template-page.md) - [Edit custom fields of the project template (batch)](https://developers.phrase.com/en/api/tms/v1/project-template/edit-custom-fields-of-the-project-template-batch.md) - [Create custom field instances](https://developers.phrase.com/en/api/tms/v1/project-template/create-custom-field-instances.md) - [Get custom field of project template](https://developers.phrase.com/en/api/tms/v1/project-template/get-custom-field-of-project-template.md) - [Edit custom field of project template](https://developers.phrase.com/en/api/tms/v1/project-template/edit-custom-field-of-project-template.md) - [Delete custom field of project template](https://developers.phrase.com/en/api/tms/v1/project-template/delete-custom-field-of-project-template.md) - [Get import settings](https://developers.phrase.com/en/api/tms/v1/project-template/get-import-settings.md) - [Edit project template import settings](https://developers.phrase.com/en/api/tms/v1/project-template/edit-project-template-import-settings.md) - [Get project template machine translate settings](https://developers.phrase.com/en/api/tms/v1/project-template/get-project-template-machine-translate-settings.md) - [Edit project template machine translate settings](https://developers.phrase.com/en/api/tms/v1/project-template/edit-project-template-machine-translate-settings.md): This will erase all mtSettings per language for project template. To remove all machine translate settings from template call without a machineTranslateSettings parameter. Alternatively, pass machineTranslateSettingsPerLangs to update the given locales only, leaving machine translate settings of oth… - [Get Pre-translate settings](https://developers.phrase.com/en/api/tms/v1/project-template/get-pre-translate-settings.md): Deprecated. Use GET /api2/v4/projectTemplates/{projectTemplateUid}/preTranslateSettings instead. - [Update Pre-translate settings](https://developers.phrase.com/en/api/tms/v1/project-template/update-pre-translate-settings.md): Deprecated. Use PUT /api2/v4/projectTemplates/{projectTemplateUid}/preTranslateSettings instead. - [Get quality assurance settings](https://developers.phrase.com/en/api/tms/v1/project-template/get-quality-assurance-settings.md) - [Edit quality assurance settings](https://developers.phrase.com/en/api/tms/v1/project-template/edit-quality-assurance-settings.md): Only checks listed in the request are updated; omitted checks keep their current settings. - [Get style guides for project template](https://developers.phrase.com/en/api/tms/v1/project-template/get-style-guides-for-project-template.md): Returns the style guides associated with the project template per target locale. Resolved either from directly assigned style guide associations, or — when the template is linked to a content group — from the content group's style guides. - [Get term bases](https://developers.phrase.com/en/api/tms/v1/project-template/get-term-bases.md) - [Edit term bases in project template](https://developers.phrase.com/en/api/tms/v1/project-template/edit-term-bases-in-project-template.md): Requires the project template to have at least one source and one target language configured. - [Get translation memories](https://developers.phrase.com/en/api/tms/v1/project-template/get-translation-memories.md): Deprecated. Use GET /api2/v3/projectTemplates/{projectTemplateUid}/transMemories instead. - [Edit translation memories](https://developers.phrase.com/en/api/tms/v1/project-template/edit-translation-memories.md): Deprecated. Use PUT /api2/v2/projectTemplates/{projectTemplateUid}/transMemories instead. Requires the project template to have at least one source and one target language configured. - [List project template relevant translation memories](https://developers.phrase.com/en/api/tms/v1/project-template/list-project-template-relevant-translation-memories.md) ### Provider - [Get suggested providers](https://developers.phrase.com/en/api/tms/v1/provider/get-suggested-providers.md) ### Quality Assurance - [List LQA profiles](https://developers.phrase.com/en/api/tms/v1/quality-assurance/list-lqa-profiles.md): Requires LQA to be enabled for the organization. Accessible to users with internal role or projectCreate access right. - [Create LQA profile](https://developers.phrase.com/en/api/tms/v1/quality-assurance/create-lqa-profile.md): Requires LQA to be enabled for the organization. Requires internal role. - [Get list of LQA profile authors](https://developers.phrase.com/en/api/tms/v1/quality-assurance/get-list-of-lqa-profile-authors.md): Requires LQA to be enabled for the organization. Accessible to users with internal role or projectCreate access right. - [Get LQA profile default values](https://developers.phrase.com/en/api/tms/v1/quality-assurance/get-lqa-profile-default-values.md): Returns dummy default values, not a persisted profile. Requires LQA to be enabled for the organization. Accessible to users with internal role or projectCreate access right. - [Get LQA profile details](https://developers.phrase.com/en/api/tms/v1/quality-assurance/get-lqa-profile-details.md): Requires LQA to be enabled for the organization. Accessible to users with internal role or projectCreate access right. - [Update LQA profile](https://developers.phrase.com/en/api/tms/v1/quality-assurance/update-lqa-profile.md): Requires LQA to be enabled for the organization. Requires internal role. - [Delete LQA profile](https://developers.phrase.com/en/api/tms/v1/quality-assurance/delete-lqa-profile.md): Returns 400 if the profile is set as the organization default or is still assigned to a project or project template. Requires LQA to be enabled for the organization. Requires internal role. - [Make LQA profile default](https://developers.phrase.com/en/api/tms/v1/quality-assurance/make-lqa-profile-default.md): Sets this profile as the organization's default LQA profile. Requires LQA to be enabled for the organization. Requires internal role. - [Duplicate LQA profile](https://developers.phrase.com/en/api/tms/v1/quality-assurance/duplicate-lqa-profile.md): Creates a copy of the specified profile with a prefix added to the name. Requires LQA to be enabled for the organization. Requires internal role. - [Run quality assurance (batch)](https://developers.phrase.com/en/api/tms/v1/quality-assurance/run-quality-assurance-batch.md) - [Edit ignored checks](https://developers.phrase.com/en/api/tms/v1/quality-assurance/edit-ignored-checks.md) - [Add ignored warnings](https://developers.phrase.com/en/api/tms/v1/quality-assurance/add-ignored-warnings.md) - [Delete ignored warnings](https://developers.phrase.com/en/api/tms/v1/quality-assurance/delete-ignored-warnings.md) - [Run quality assurance](https://developers.phrase.com/en/api/tms/v1/quality-assurance/run-quality-assurance.md) ### Quality Profile - [Trigger quality evaluation based on quality profile for selected job parts](https://developers.phrase.com/en/api/tms/v1/quality-profile/trigger-quality-evaluation-based-on-quality-profile-for-selected-job-parts.md): Results are retrieved via POST /api2/v1/qualityProfiles/qeWarnings with the same job part UIDs; there is no GET endpoint for per-job evaluation results. - [Get QE warnings for selected job parts](https://developers.phrase.com/en/api/tms/v1/quality-profile/get-qe-warnings-for-selected-job-parts.md): Returns AI-generated quality estimation warnings for the selected job parts. Only call this after the async evaluation job started by POST /api2/v1/qualityProfiles/evaluate has completed (asyncResponse != null on GET /api2/v1/async/{asyncRequest.id}). Calling before completion returns empty segmentW… - [Store evaluation warnings for a job part](https://developers.phrase.com/en/api/tms/v1/quality-profile/store-evaluation-warnings-for-a-job-part.md): Stores segment-level quality evaluation warnings for the specified job part. Each segment's existing evaluation runs on the converter are overwritten with the provided results — prior history is not preserved. An empty results array for a segment records a passing run. Maximum 500 segments per reque… ### Quote - [Create quote](https://developers.phrase.com/en/api/tms/v1/quote/create-quote.md): Deprecated. Use /api2/v2/quotes instead. Price lists with Hour billing unit are not supported. - [Email quotes](https://developers.phrase.com/en/api/tms/v1/quote/email-quotes.md): Sends a quote summary email to providers. All referenced quotes must have a provider assigned. - [Get quote](https://developers.phrase.com/en/api/tms/v1/quote/get-quote.md) - [Delete quote](https://developers.phrase.com/en/api/tms/v1/quote/delete-quote.md): Deletes the quote. Requires the quote-edit project-space permission; project "delete other" permission alone is not sufficient. ### Reference File - [List project template reference files](https://developers.phrase.com/en/api/tms/v1/reference-file/list-project-template-reference-files.md): Accessible by Administrator, Project Manager, Guest, and Linguist roles. The `filename` parameter filters by substring match. The `createdBy` field in each result is null when the creator belongs to a different organization. - [Create project template reference files](https://developers.phrase.com/en/api/tms/v1/reference-file/create-project-template-reference-files.md): The `json` request part allows sending additional data as JSON, such as a text note that will be used for all the given reference files. In case no `file` parts are sent, only 1 reference is created with the given note. Either at least one file must be sent or the note must be specified. Example: - [Delete project template reference files (batch)](https://developers.phrase.com/en/api/tms/v1/reference-file/delete-project-template-reference-files-batch.md): Required role: Administrator or Project Manager. All reference files must belong to the same organization as the current user. The underlying file in storage is deleted if no other reference points to it. Returns 400 if any reference file does not belong to the specified project template. - [Download project template reference files (batch)](https://developers.phrase.com/en/api/tms/v1/reference-file/download-project-template-reference-files-batch.md): Accessible by Administrator, Project Manager, Guest, and Linguist roles. Returns a single file when one reference is selected, or a ZIP archive for multiple. Returns 400 if any reference file does not belong to the specified project template. - [Download project template reference file](https://developers.phrase.com/en/api/tms/v1/reference-file/download-project-template-reference-file.md): Accessible by Administrator, Project Manager, Guest, and Linguist roles. Returns 400 if the reference file does not belong to the specified project template. - [List project reference files](https://developers.phrase.com/en/api/tms/v1/reference-file/list-project-reference-files.md) - [Create project reference file](https://developers.phrase.com/en/api/tms/v1/reference-file/create-project-reference-file.md): Accepts `application/octet-stream` or `application/json`.
- `application/json` - `note` field will be converted to .txt.
- `application/octet-stream` - `Content-Disposition` header is required.
Required role: Administra… - [Delete project reference files (batch)](https://developers.phrase.com/en/api/tms/v1/reference-file/delete-project-reference-files-batch.md): Required role: Administrator, Project Manager, Guest, or Submitter. Vendor organizations may delete only their own files if the project security settings allow it (`securitySettings.vendors.jobVendorsMayUploadReferences`, see Get project). The underlyi… - [List project reference file creators](https://developers.phrase.com/en/api/tms/v1/reference-file/list-project-reference-file-creators.md): The result is not paged and returns up to 50 users. If the requested user is not included, the search can be narrowed down with the `userName` parameter. - [Download project reference files (batch)](https://developers.phrase.com/en/api/tms/v1/reference-file/download-project-reference-files-batch.md): Returns a single file when one reference is selected, or a ZIP archive for multiple. Reference files are identified by integer ID (not UID). - [Download project reference file](https://developers.phrase.com/en/api/tms/v1/reference-file/download-project-reference-file.md) ### SCIM - [List the types of SCIM Resources available](https://developers.phrase.com/en/api/tms/v1/scim/list-the-types-of-scim-resources-available.md) - [Get supported SCIM Schemas](https://developers.phrase.com/en/api/tms/v1/scim/get-supported-scim-schemas.md) - [Get supported SCIM Schema by urn](https://developers.phrase.com/en/api/tms/v1/scim/get-supported-scim-schema-by-urn.md) - [Retrieve the Service Provider's Configuration](https://developers.phrase.com/en/api/tms/v1/scim/retrieve-the-service-providers-configuration.md) - [Search users](https://developers.phrase.com/en/api/tms/v1/scim/search-users.md): This operation supports SCIM Filter, SCIM attributes and SCIM sort - [Create user using SCIM](https://developers.phrase.com/en/api/tms/v1/scim/create-user-using-scim.md): Requires a valid Bearer token in the Authorization header. - [Get user](https://developers.phrase.com/en/api/tms/v1/scim/get-user.md): Requires a valid Bearer token in the Authorization header. - [Edit user using SCIM](https://developers.phrase.com/en/api/tms/v1/scim/edit-user-using-scim.md): Requires a valid Bearer token in the Authorization header. - [Delete user using SCIM](https://developers.phrase.com/en/api/tms/v1/scim/delete-user-using-scim.md): Deletes the user and limits the validity of existing access tokens. Requires a valid Bearer token in the Authorization header. - [Patch user using SCIM](https://developers.phrase.com/en/api/tms/v1/scim/patch-user-using-scim.md): Requires a valid Bearer token in the Authorization header. ### Segmentation Rules - [List segmentation rules](https://developers.phrase.com/en/api/tms/v1/segmentation-rules/list-segmentation-rules.md): Lists segmentation rules of the organization. The language and languages parameters are mutually exclusive; providing both returns 400 Bad Request. The locales parameter is normalized before filtering. Requires an internal role (ADMIN or PROJECT_MANAGER). - [Create segmentation rule](https://developers.phrase.com/en/api/tms/v1/segmentation-rules/create-segmentation-rule.md): Creates a new segmentation rule from the streamed file and the segRule JSON object passed in the segRule header. The segRule header carries a JSON object with the fields name, locale, primary and filename (the same SegmentationRuleDto shape returned by the GET action). Requires an internal role (ADM… - [Get owners of segmentation rules](https://developers.phrase.com/en/api/tms/v1/segmentation-rules/get-owners-of-segmentation-rules.md): Requires an internal role (ADMIN or PROJECT_MANAGER). - [Export default segmentation rules](https://developers.phrase.com/en/api/tms/v1/segmentation-rules/export-default-segmentation-rules.md) - [Get segmentation rule](https://developers.phrase.com/en/api/tms/v1/segmentation-rules/get-segmentation-rule.md): Requires an internal role (ADMIN or PROJECT_MANAGER). - [Edit segmentation rule](https://developers.phrase.com/en/api/tms/v1/segmentation-rules/edit-segmentation-rule.md): Requires an internal role (ADMIN or PROJECT_MANAGER) with the setupServer access right. - [Delete segmentation rule](https://developers.phrase.com/en/api/tms/v1/segmentation-rules/delete-segmentation-rule.md): Deletes a segmentation rule and clears its references from converter import settings. Requires an internal role (ADMIN or PROJECT_MANAGER) with the setupServer access right. - [Export segmentation rule](https://developers.phrase.com/en/api/tms/v1/segmentation-rules/export-segmentation-rule.md) - [Replace segmentation rule file](https://developers.phrase.com/en/api/tms/v1/segmentation-rules/replace-segmentation-rule-file.md): Replaces the file content of an existing segmentation rule, preserving its id and uid. Requires an internal role (ADMIN or PROJECT_MANAGER) with the setupServer access right. ### Service - [List services](https://developers.phrase.com/en/api/tms/v1/service/list-services.md): Requires ADMIN or PROJECT_MANAGER role with the Server Setup access right enabled. - [Create service](https://developers.phrase.com/en/api/tms/v1/service/create-service.md) - [Delete services (batch)](https://developers.phrase.com/en/api/tms/v1/service/delete-services-batch.md) - [Get service](https://developers.phrase.com/en/api/tms/v1/service/get-service.md) - [Edit service](https://developers.phrase.com/en/api/tms/v1/service/edit-service.md): Partial update — omitted fields retain their current values. - [Delete service](https://developers.phrase.com/en/api/tms/v1/service/delete-service.md) ### Spell Check - [Spell check](https://developers.phrase.com/en/api/tms/v1/spell-check/spell-check.md): Spell check using the settings of the user's organization - [Spell check for job](https://developers.phrase.com/en/api/tms/v1/spell-check/spell-check-for-job.md): Spell check using the settings from the project of the job - [Suggest a word](https://developers.phrase.com/en/api/tms/v1/spell-check/suggest-a-word.md): Spell check suggest using the users's spell check dictionary - [Add word to dictionary](https://developers.phrase.com/en/api/tms/v1/spell-check/add-word-to-dictionary.md) ### SubDomain - [List subdomains](https://developers.phrase.com/en/api/tms/v1/subdomain/list-subdomains.md): Subdomain is used together with domain to further refine the content-type/category classification of projects, project templates, translation memories, and term bases. Linguists, submitters, and guests receive only subdomains from projects they are assigned to. - [Create subdomain](https://developers.phrase.com/en/api/tms/v1/subdomain/create-subdomain.md): Requires the subDomainCreate access right. Subdomain names must be unique within the organization. - [Get subdomain](https://developers.phrase.com/en/api/tms/v1/subdomain/get-subdomain.md): Project managers who did not create the subdomain need the clientViewOther access right (default off) to view it. - [Edit subdomain](https://developers.phrase.com/en/api/tms/v1/subdomain/edit-subdomain.md): Project managers can edit another user's subdomain only if they have the clientEditOther access right (default off). - [Delete subdomain](https://developers.phrase.com/en/api/tms/v1/subdomain/delete-subdomain.md): Deleting a subdomain clears its reference from all projects, project templates, term bases, and translation memories. Project managers who did not create the subdomain need the clientDeleteOther access right (default off) to delete it. ### Supported Languages - [List supported languages](https://developers.phrase.com/en/api/tms/v1/supported-languages/list-supported-languages.md): When the active parameter is omitted or false, all languages supported by the platform are returned. When active is true, the result is filtered to the locales currently enabled for the calling user's organization. ### Term Base - [Create term in job's term bases](https://developers.phrase.com/en/api/tms/v1/term-base/create-term-in-jobs-term-bases.md): Create new term in the write term base assigned to the job - [Search job's term bases](https://developers.phrase.com/en/api/tms/v1/term-base/search-jobs-term-bases.md): Search all read term bases assigned to the job. Deprecated; use v2. - [Search terms in text](https://developers.phrase.com/en/api/tms/v1/term-base/search-terms-in-text.md): Search in text in all read term bases assigned to the job. Deprecated; use v2. - [List term bases](https://developers.phrase.com/en/api/tms/v1/term-base/list-term-bases.md): Term base only; does not accept a glossary UID. Glossaries have their own dedicated account-level CRUD under /api2/v1/glossaries. - [Create term base](https://developers.phrase.com/en/api/tms/v1/term-base/create-term-base.md): Governs the term base resource itself (name, languages, ownership, whole-term-base deletion) via account-level term-base rights. This is distinct from the per-term content permissions on the terms/concepts endpoints below, which also allow LINGUIST users assigned to the project (see createTerm/updat… - [Get term base](https://developers.phrase.com/en/api/tms/v1/term-base/get-term-base.md): Term base only; does not accept a glossary UID. Glossaries have their own dedicated account-level CRUD under /api2/v1/glossaries. - [Edit term base](https://developers.phrase.com/en/api/tms/v1/term-base/edit-term-base.md): It is possible to add new languages only. Governs the term base resource itself (name, languages, ownership, whole-term-base deletion) via account-level term-base rights. This is distinct from the per-term content permissions on the terms/concepts endpoints below, which also allow LINGUIST users ass… - [Delete term base](https://developers.phrase.com/en/api/tms/v1/term-base/delete-term-base.md): Governs the term base resource itself (name, languages, ownership, whole-term-base deletion) via account-level term-base rights. This is distinct from the per-term content permissions on the terms/concepts endpoints below, which also allow LINGUIST users assigned to the project (see createTerm/updat… - [Browse term base](https://developers.phrase.com/en/api/tms/v1/term-base/browse-term-base.md): Term base only; does not accept a glossary UID. - [List concepts](https://developers.phrase.com/en/api/tms/v1/term-base/list-concepts.md): Works against both a term base UID and a glossary UID — Glossary and TermBase are sibling resource types, and this endpoint resolves termBaseUid polymorphically against either. When termBaseUid refers to a glossary, access is restricted to ADMIN/PROJECT_MANAGER users with the setupServer right, rath… - [Create concept](https://developers.phrase.com/en/api/tms/v1/term-base/create-concept.md): Creates an empty concept grouping with no terms. To add terms, use POST /api2/v1/termBases/{termBaseUid}/terms with conceptId pointing to this concept. Works against both a term base UID and a glossary UID — Glossary and TermBase are sibling resource types, and this endpoint resolves termBaseUid pol… - [Delete concepts](https://developers.phrase.com/en/api/tms/v1/term-base/delete-concepts.md): Callable by ADMIN, PROJECT_MANAGER, and LINGUIST users assigned to the term base's project. This is distinct from the account-level rights gating the term base resource itself (see createTermBase/updateTermBase/deleteTermBase). There is no purge/restore option — the concepts and all their terms cann… - [Get concept](https://developers.phrase.com/en/api/tms/v1/term-base/get-concept.md): Works against both a term base UID and a glossary UID — Glossary and TermBase are sibling resource types, and this endpoint resolves termBaseUid polymorphically against either. When termBaseUid refers to a glossary, access is restricted to ADMIN/PROJECT_MANAGER users with the setupServer right, rath… - [Update concept](https://developers.phrase.com/en/api/tms/v1/term-base/update-concept.md): Works against both a term base UID and a glossary UID — Glossary and TermBase are sibling resource types, and this endpoint resolves termBaseUid polymorphically against either. When termBaseUid refers to a glossary, access is restricted to ADMIN/PROJECT_MANAGER users with the setupServer right, rath… - [Delete concept](https://developers.phrase.com/en/api/tms/v1/term-base/delete-concept.md): Callable by ADMIN, PROJECT_MANAGER, and LINGUIST users assigned to the term base's project. This is distinct from the account-level rights gating the term base resource itself (see createTermBase/updateTermBase/deleteTermBase). There is no purge/restore option — the concept and all its terms cannot… - [Get terms of concept](https://developers.phrase.com/en/api/tms/v1/term-base/get-terms-of-concept.md): Works against both a term base UID and a glossary UID — Glossary and TermBase are sibling resource types, and this endpoint resolves termBaseUid polymorphically against either. When termBaseUid refers to a glossary, access is restricted to ADMIN/PROJECT_MANAGER users with the setupServer right, rath… - [Export term base](https://developers.phrase.com/en/api/tms/v1/term-base/export-term-base.md): Term base only; does not accept a glossary UID. - [Last import status](https://developers.phrase.com/en/api/tms/v1/term-base/last-import-status.md): Works against both a term base UID and a glossary UID — Glossary and TermBase are sibling resource types, and this endpoint resolves termBaseUid polymorphically against either. When termBaseUid refers to a glossary, access is restricted to ADMIN/PROJECT_MANAGER users with the setupServer right, rath… - [Get term base metadata](https://developers.phrase.com/en/api/tms/v1/term-base/get-term-base-metadata.md): Works against both a term base UID and a glossary UID — Glossary and TermBase are sibling resource types, and this endpoint resolves termBaseUid polymorphically against either. When termBaseUid refers to a glossary, access is restricted to ADMIN/PROJECT_MANAGER users with the setupServer right, rath… - [List related projects](https://developers.phrase.com/en/api/tms/v1/term-base/list-related-projects.md): Reverse lookup of the projects a term base is attached to or assigned to. Term base only; does not accept a glossary UID — glossaries attach to machine translation profiles rather than to projects, so there is no equivalent relatedProjects endpoint for glossaries. - [Search term base](https://developers.phrase.com/en/api/tms/v1/term-base/search-term-base.md): Term base only; does not accept a glossary UID. - [Create term](https://developers.phrase.com/en/api/tms/v1/term-base/create-term.md): Set conceptId to assign the term to an existing concept, otherwise a new concept will be created. Callable by ADMIN, PROJECT_MANAGER, and LINGUIST users assigned to the term base's project. A LINGUIST can always create a term with status New; creating a term with status Approved additionally require… - [Clear term base](https://developers.phrase.com/en/api/tms/v1/term-base/clear-term-base.md): Deletes all terms. Term base only; does not accept a glossary UID. - [Get term](https://developers.phrase.com/en/api/tms/v1/term-base/get-term.md): Works against both a term base UID and a glossary UID — Glossary and TermBase are sibling resource types, and this endpoint resolves termBaseUid polymorphically against either. When termBaseUid refers to a glossary, access is restricted to ADMIN/PROJECT_MANAGER users with the setupServer right, rath… - [Edit term](https://developers.phrase.com/en/api/tms/v1/term-base/edit-term.md): Callable by ADMIN, PROJECT_MANAGER, and LINGUIST users assigned to the term base's project. A LINGUIST can always edit a term with status New; editing/approving an already-Approved term additionally requires the user's editAllTermsInTB right. This is distinct from the account-level rights gating the… - [Delete term](https://developers.phrase.com/en/api/tms/v1/term-base/delete-term.md): Callable by ADMIN, PROJECT_MANAGER, and LINGUIST users assigned to the term base's project. A LINGUIST can always delete a term with status New; deleting an already-Approved term additionally requires the user's editAllTermsInTB right. This is distinct from the account-level rights gating the term b… - [Upload term base](https://developers.phrase.com/en/api/tms/v1/term-base/upload-term-base.md): Deprecated. Use POST /api2/v2/termBases/{termBaseUid}/upload instead. Terms can be imported from XLS/XLSX and TBX file formats into a term base. See Phrase Help Center. Term base only; does not accept a glossary… ### Translation - [Human translate (Gengo or Unbabel)](https://developers.phrase.com/en/api/tms/v1/translation/human-translate-gengo-or-unbabel.md) - [Pre-translate job](https://developers.phrase.com/en/api/tms/v1/translation/pre-translate-job.md) - [Translate using machine translation](https://developers.phrase.com/en/api/tms/v1/translation/translate-using-machine-translation.md): Translates source texts using the job's configured machine translation settings. The MT origin is determined from request headers. Requires job machine translation access; project-level machine translation access may also be checked. ### Translation Memory - [Search job's translation memories](https://developers.phrase.com/en/api/tms/v1/translation-memory/search-jobs-translation-memories.md): Deprecated. This API is incorrectly implemented, use endpoint Search translation memory for segment by job.
Returns at most maxSegments records with score >= scoreThreshold and at most maxSubsegments records which are subs… - [Search translation memory for segment by job](https://developers.phrase.com/en/api/tms/v1/translation-memory/search-translation-memory-for-segment-by-job.md): Returns at most maxSegments records with score >= scoreThreshold and at most maxSubsegments records which are subsegment, i.e. the source text is substring of the query text. - [List translation memories](https://developers.phrase.com/en/api/tms/v1/translation-memory/list-translation-memories.md): Deprecated. Use GET /api2/v2/transMemories instead. - [Create translation memory](https://developers.phrase.com/en/api/tms/v1/translation-memory/create-translation-memory.md): Creates a new translation memory. At least one target language must be provided. Optional associations (client, domain, subDomain, businessUnit) are resolved by ID. Requires the caller to have the transMemoryCreate access right. - [Delete translation memories (batch)](https://developers.phrase.com/en/api/tms/v1/translation-memory/delete-translation-memories-batch.md): Deletes up to 100 translation memories in a single request. When purge=true on the request body all listed TMs are permanently erased. Each TM UID must be accessible to the caller; a missing or forbidden UID causes the entire request to fail. - [Download cleaned TM](https://developers.phrase.com/en/api/tms/v1/translation-memory/download-cleaned-tm.md): Downloads the ZIP archive produced by extractCleaned. Returns 403 Forbidden when the extract-cleaned feature is not enabled for the organisation. The asyncRequest must be in a completed state. - [Download export](https://developers.phrase.com/en/api/tms/v1/translation-memory/download-export.md): Downloads the TMX or XLSX file produced by exportByQueryAsync. The asyncRequest must be in a completed state before downloading. Use the fields parameter to select which columns to include when format=XLSX. Use the packaging parameter to wrap a TMX download in a ZIP archive containing a single TMX e… - [Extract cleaned translation memory](https://developers.phrase.com/en/api/tms/v1/translation-memory/extract-cleaned-translation-memory.md): Queues an asynchronous job that extracts cleaned TM content into a ZIP archive. Returns 403 Forbidden when the extract-cleaned feature is not enabled for the organisation. Poll the returned asyncRequest for completion, then download the result via downloadCleaned/{asyncRequestId}. - [Get translation memory](https://developers.phrase.com/en/api/tms/v1/translation-memory/get-translation-memory.md) - [Edit translation memory](https://developers.phrase.com/en/api/tms/v1/translation-memory/edit-translation-memory.md) - [Delete translation memory](https://developers.phrase.com/en/api/tms/v1/translation-memory/delete-translation-memory.md): Deletes the specified translation memory. When purge=true the TM data is permanently erased; otherwise the TM is soft-deleted and can be recovered by an administrator. Requires internal role and DELETE permission on the TM. - [Export translation memory](https://developers.phrase.com/en/api/tms/v1/translation-memory/export-translation-memory.md): Deprecated. Admin, Project Manager, and Guest callers should use exportByQueryAsync instead (same role restriction applies there). Downloads the full TM as a TMX or XLSX file. The response is a binary octet-stream; the filename is set via the Content-Disposition header. When targetLang is omitted, a… - [Search translation memory](https://developers.phrase.com/en/api/tms/v1/translation-memory/search-translation-memory.md): **Overview** Runs an asynchronous TMX export based on optional wildcard/phrase queries and optional metadata filters. The job streams filtered translation units into TMX via the downstream `/export_tmx_by_query` endpoint. Use `downloadExport/{asyncRequestId}` to fetch the finished file. - [Import segments](https://developers.phrase.com/en/api/tms/v1/translation-memory/import-segments.md): Deprecated. Imports TMX or XLSX segments into an existing TM via an octet-stream body. The Content-Disposition header must supply a filename so the format can be determined. Returns counts of accepted, created, updated and skipped segments. - [Get last task information](https://developers.phrase.com/en/api/tms/v1/translation-memory/get-last-task-information.md) - [Get translation memory metadata](https://developers.phrase.com/en/api/tms/v1/translation-memory/get-translation-memory-metadata.md) - [List related projects](https://developers.phrase.com/en/api/tms/v1/translation-memory/list-related-projects.md): Reverse lookup of the projects a translation memory is attached to, used in, or assigned to. - [Search translation memory (sync)](https://developers.phrase.com/en/api/tms/v1/translation-memory/search-translation-memory-sync.md): **Overview** - Searches a single translation memory using the primary TM scoring pipeline. The endpoint always returns up to 15 `SearchTMResponseDto` entries ordered by score. - [Search TM content](https://developers.phrase.com/en/api/tms/v1/translation-memory/search-tm-content.md): **Overview** - Searches TM content within a single Translation Memory (TM), matching against source and/or target segment text, with optional metadata filters. - [Insert segment](https://developers.phrase.com/en/api/tms/v1/translation-memory/insert-segment.md) - [Delete all segments](https://developers.phrase.com/en/api/tms/v1/translation-memory/delete-all-segments.md): Deprecated. Use DELETE /api2/v2/transMemories/{transMemoryUid}/segments instead. - [Edit segment](https://developers.phrase.com/en/api/tms/v1/translation-memory/edit-segment.md) - [Delete both source and translation](https://developers.phrase.com/en/api/tms/v1/translation-memory/delete-both-source-and-translation.md): Not recommended for bulk removal of segments. This operation is permanent - deleted segments cannot be recovered. - [Delete segment of given language](https://developers.phrase.com/en/api/tms/v1/translation-memory/delete-segment-of-given-language.md): Not recommended for bulk removal of segments. This operation is permanent - deleted segments cannot be recovered. - [Add target language to translation memory](https://developers.phrase.com/en/api/tms/v1/translation-memory/add-target-language-to-translation-memory.md) - [Wildcard search](https://developers.phrase.com/en/api/tms/v1/translation-memory/wildcard-search.md): **Overview** - Searches a single translation memory via Elasticsearch wildcard queries and returns up to `count` matches. ### User - [List users](https://developers.phrase.com/en/api/tms/v1/user/list-users.md) - [Create user](https://developers.phrase.com/en/api/tms/v1/user/create-user.md) - [List last login dates](https://developers.phrase.com/en/api/tms/v1/user/list-last-login-dates.md) - [Get user](https://developers.phrase.com/en/api/tms/v1/user/get-user.md) - [Edit user](https://developers.phrase.com/en/api/tms/v1/user/edit-user.md) - [Delete user](https://developers.phrase.com/en/api/tms/v1/user/delete-user.md) - [Send login information](https://developers.phrase.com/en/api/tms/v1/user/send-login-information.md) - [List jobs assigned to user across all projects](https://developers.phrase.com/en/api/tms/v1/user/list-jobs-assigned-to-user-across-all-projects.md): Returns jobs assigned to the given user across all projects and all workflow steps - unlike GET /api2/v2/projects/{projectUid}/jobs, this endpoint has no default `workflowLevel` restriction. - [Login statistics](https://developers.phrase.com/en/api/tms/v1/user/login-statistics.md): Returns login activity for the specified user. ADMIN users can view any user's activity; non-admin users can only view their own. - [List assigned projects](https://developers.phrase.com/en/api/tms/v1/user/list-assigned-projects.md): List projects in which the user is assigned to at least one job matching the criteria. ADMIN and PROJECT_MANAGER callers receive a richer ProjectAdminReference response; all other roles receive a ProjectLinguistReference response. - [List assigned target languages](https://developers.phrase.com/en/api/tms/v1/user/list-assigned-target-languages.md) - [Restore user](https://developers.phrase.com/en/api/tms/v1/user/restore-user.md): Restores a previously deleted user. Requires ADMIN role. The user must belong to the same organization and must not be a bot account. - [Update password](https://developers.phrase.com/en/api/tms/v1/user/update-password.md): Can be used by the user to update their own password or by ADMIN to update password of user without joined account * Password length must be between 8 and 255 * Password must not be same as the username - [List assigned workflow steps](https://developers.phrase.com/en/api/tms/v1/user/list-assigned-workflow-steps.md) ### User Profile - [Get my profile](https://developers.phrase.com/en/api/tms/v1/user-profile/get-my-profile.md) - [Edit my profile](https://developers.phrase.com/en/api/tms/v1/user-profile/edit-my-profile.md): If the caller's identity is managed by an external identity provider (SSO/SCIM/SAML), the readonly flag in the response is true and firstName/lastName/email changes are silently ignored - only the subscribed flag is applied (when marketing consent is not hidden). Check readonly beforehand to avoid r… ### Vendor - [List vendors](https://developers.phrase.com/en/api/tms/v1/vendor/list-vendors.md): Returns only approved vendors. - [Create vendor](https://developers.phrase.com/en/api/tms/v1/vendor/create-vendor.md) - [Delete vendors (batch)](https://developers.phrase.com/en/api/tms/v1/vendor/delete-vendors-batch.md) - [Get vendor](https://developers.phrase.com/en/api/tms/v1/vendor/get-vendor.md) - [Update vendor](https://developers.phrase.com/en/api/tms/v1/vendor/update-vendor.md): Full replace of the net rate scheme, price list, locales, and client/domain/sub-domain/workflow step associations. Fields omitted from the request body clear the existing association. ### Webhook - [Lists webhooks](https://developers.phrase.com/en/api/tms/v1/webhook/lists-webhooks.md): Deprecated. Use /api2/v2/webhooks instead. - [Create webhook](https://developers.phrase.com/en/api/tms/v1/webhook/create-webhook.md): Deprecated. Use /api2/v2/webhooks instead. - [Get webhook](https://developers.phrase.com/en/api/tms/v1/webhook/get-webhook.md): Deprecated. Use /api2/v2/webhooks instead. - [Edit webhook](https://developers.phrase.com/en/api/tms/v1/webhook/edit-webhook.md): Deprecated. Use /api2/v2/webhooks instead. - [Delete webhook](https://developers.phrase.com/en/api/tms/v1/webhook/delete-webhook.md): Deprecated. Use /api2/v2/webhooks instead. - [Lists webhook calls](https://developers.phrase.com/en/api/tms/v1/webhook/lists-webhook-calls.md) - [Replay webhook calls](https://developers.phrase.com/en/api/tms/v1/webhook/replay-webhook-calls.md): Replays given list of Webhook Calls in specified order in the request - [Replay last webhook calls](https://developers.phrase.com/en/api/tms/v1/webhook/replay-last-webhook-calls.md): Replays specified number of last Webhook calls from oldest to the newest one ### Workflow Step - [List workflow steps](https://developers.phrase.com/en/api/tms/v1/workflow-step/list-workflow-steps.md): Accessible to ADMIN, PROJECT_MANAGER, GUEST, and LINGUIST roles. Returns 403 if the organization plan does not support workflow steps. - [Create workflow step](https://developers.phrase.com/en/api/tms/v1/workflow-step/create-workflow-step.md): Requires ADMIN or PROJECT_MANAGER role with the setup-server access right. Abbreviation must be unique within the organization. When order is omitted, the step is appended to the end of the organization's workflow step list (highest existing order + 10, or 0 if none exist). On success, the new step… - [Get workflow step](https://developers.phrase.com/en/api/tms/v1/workflow-step/get-workflow-step.md): Requires ADMIN or PROJECT_MANAGER role with the setup-server access right. Returns 403 if the organization plan does not support workflow steps. - [Edit workflow step](https://developers.phrase.com/en/api/tms/v1/workflow-step/edit-workflow-step.md): Requires ADMIN or PROJECT_MANAGER role with the setup-server access right. All fields are optional; omitted or null fields retain their existing values. Abbreviation must be unique within the organization. Returns 403 if the organization plan does not support workflow steps or if LQA is not enabled… - [Delete workflow step](https://developers.phrase.com/en/api/tms/v1/workflow-step/delete-workflow-step.md): Requires ADMIN or PROJECT_MANAGER role with the setup-server access right. Soft-deletes the step and removes all associated price list entries. Returns 403 if the organization plan does not support workflow steps. ### XML Assistant - [Get XML assistant profiles for organization](https://developers.phrase.com/en/api/tms/v1/xml-assistant/get-xml-assistant-profiles-for-organization.md) ## OpenAPI Specs - [phrase-tms-v1](/openapi/phrase-tms-v1.json)