Open Connector
← All tools

Lokalise logoLokalise

No catalog description yet.

lokalisevcatalog-v1109 tools

Authentication

MethodKindStatusDetails
OAuth 2.0oauth2available—

Call a tool

import { createClient } from "@open-connector/sdk";const oc = createClient({  baseUrl: "https://api.openconnector.dev",  apiKey: process.env.OPEN_CONNECTOR_API_KEY!,});const result = await oc.executeTool({  slug: "LOKALISE_ADD_MEMBERS_TO_GROUP",  connectedAccountId: "conn_...",  arguments: { /* match this tool's input schema */ },});
import Composio from "@composio/client";const composio = new Composio({  baseURL: "https://api.openconnector.dev/composio",  apiKey: process.env.OPEN_CONNECTOR_API_KEY!,});const result = await composio.tools.execute("LOKALISE_ADD_MEMBERS_TO_GROUP", {  connected_account_id: "conn_...",  arguments: { /* match this tool's input schema */ },});
oc tools execute LOKALISE_ADD_MEMBERS_TO_GROUP --data '{ }'

Tool catalog

Available tools

109 callable operations

Add members to groupLOKALISE_ADD_MEMBERS_TO_GROUPRequires *Admin* right in the team. Requires <code>write_team_groups</code> OAuth access scope.

Requires *Admin* right in the team. Requires <code>write_team_groups</code> OAuth access scope.

Authentication

Connected account required

Tags

Team Groups
Add projects to groupLOKALISE_ADD_PROJECTS_TO_GROUPRequires *Admin* right in the team. Requires <code>write_team_groups</code> OAuth access scope.

Requires *Admin* right in the team. Requires <code>write_team_groups</code> OAuth access scope.

Authentication

Connected account required

Tags

Team Groups
Multi-updateLOKALISE_BULK_UPDATEUpdates one or more keys in the project. Requires *Manage keys* admin right. Requires <code>write_keys</code> OAuth access scope.

Updates one or more keys in the project. Requires *Manage keys* admin right. Requires <code>write_keys</code> OAuth access scope.

Authentication

Connected account required

Tags

Keys
Create a cardLOKALISE_CREATE_A_CARDAdds new payment card to user cards. Requires <code>write_payment_cards</code> OAuth access scope.

Adds new payment card to user cards. Requires <code>write_payment_cards</code> OAuth access scope.

Authentication

Connected account required

Tags

Payment Cards
Create a groupLOKALISE_CREATE_A_GROUPCreates a group in the team. Requires *Admin* right in the team. If `is_admin` flag is set to `true`, the group would automatically get access to all project languages, overriding supplied `languages` object. Requires <code>write_team_groups</code> OAuth access scope.

Creates a group in the team. Requires *Admin* right in the team. If `is_admin` flag is set to `true`, the group would automatically get access to all project languages, overriding supplied `languages` object. Requires <code>write_team_groups</code> OAuth access scope.

Authentication

Connected account required

Tags

Team Groups
Create a projectLOKALISE_CREATE_A_PROJECTCreates a new project in the specified team. Requires *Admin* role in the team. Requires <code>write_projects</code> OAuth access scope.

Creates a new project in the specified team. Requires *Admin* role in the team. Requires <code>write_projects</code> OAuth access scope.

Authentication

Connected account required

Tags

Projects
Create a snapshotLOKALISE_CREATE_A_SNAPSHOTCreates snapshot of the project. Requires *Manage settings* admin right. Requires <code>write_snapshots</code> OAuth access scope.

Creates snapshot of the project. Requires *Manage settings* admin right. Requires <code>write_snapshots</code> OAuth access scope.

Authentication

Connected account required

Tags

Snapshots
Create a statusLOKALISE_CREATE_A_STATUSCreates a custom translation status in the project. Requires <code>write_custom_translation_statuses</code> OAuth access scope.

Creates a custom translation status in the project. Requires <code>write_custom_translation_statuses</code> OAuth access scope.

Authentication

Connected account required

Tags

Custom Translation Statuses
Create a taskLOKALISE_CREATE_A_TASKCreates a task in the project. Requires *Manage tasks* admin right. Keep in mind, that <code>initial_tm_leverage</code> attribute will be empty in server response. It's being calculated after the task is created and this process may take some time. Requires <code>write_tasks</code> OAuth access scope.

Creates a task in the project. Requires *Manage tasks* admin right. Keep in mind, that <code>initial_tm_leverage</code> attribute will be empty in server response. It's being calculated after the task is created and this process may take some time. Requires <code>write_tasks</code> OAuth access scope.

Authentication

Connected account required

Tags

Tasks
Create a webhookLOKALISE_CREATE_A_WEBHOOKCreates a webhook in the project. Requires *Manage settings* admin right. See our <a href="https://docs.lokalise.com/en/articles/3184756-webhooks" target="_blank" rel="noopener noreferrer">documentation</a> for available events and payload examples. Requires <code>write_webhooks</code> OAuth access scope.

Creates a webhook in the project. Requires *Manage settings* admin right. See our <a href="https://docs.lokalise.com/en/articles/3184756-webhooks" target="_blank" rel="noopener noreferrer">documentation</a> for available events and payload examples. Requires <code>write_webhooks</code> OAuth access scope.

Authentication

Connected account required

Tags

Webhooks
Create an orderLOKALISE_CREATE_AN_ORDERCreates a translation order. You must have admin privileges in the project you are placing an order in. Requires <code>write_team_orders</code> OAuth access scope.

Creates a translation order. You must have admin privileges in the project you are placing an order in. Requires <code>write_team_orders</code> OAuth access scope.

Authentication

Connected account required

Tags

Orders
Create commentsLOKALISE_CREATE_COMMENTSAdds a set of comments to the key. Requires <code>write_comments</code> OAuth access scope.

Adds a set of comments to the key. Requires <code>write_comments</code> OAuth access scope.

Authentication

Connected account required

Tags

Comments
Create contributorsLOKALISE_CREATE_CONTRIBUTORSCreates one or more contributors in the project. Requires *Manage contributors* admin right. If `is_admin` flag is set to `true`, the user would automatically get access to all project languages, overriding supplied `languages` object. Attribute `fullname` will be ignored, if the user has already been registered in Lokalise. Requires <code>write_contributors</code> OAuth access scope.

Creates one or more contributors in the project. Requires *Manage contributors* admin right. If `is_admin` flag is set to `true`, the user would automatically get access to all project languages, overriding supplied `languages` object. Attribute `fullname` will be ignored, if the user has already been registered in Lokalise. Requires <code>write_contributors</code> OAuth access scope.

Authentication

Connected account required

Tags

Contributors
Create glossary termsLOKALISE_CREATE_GLOSSARY_TERMSCreates one or more glossary terms in the project. Requires *Manage glossary* admin right. Requires <code>write_glossary</code> OAuth access scope.

Creates one or more glossary terms in the project. Requires *Manage glossary* admin right. Requires <code>write_glossary</code> OAuth access scope.

Authentication

Connected account required

Tags

Glossary
Create keysLOKALISE_CREATE_KEYSCreates one or more keys in the project. Requires *Manage keys* admin right. We recommend sending payload in chunks of up to 500 keys per request. Requires <code>write_keys</code> OAuth access scope.

Creates one or more keys in the project. Requires *Manage keys* admin right. We recommend sending payload in chunks of up to 500 keys per request. Requires <code>write_keys</code> OAuth access scope.

Authentication

Connected account required

Tags

Keys
Create languagesLOKALISE_CREATE_LANGUAGESCreates one or more languages in the project. Requires *Manage languages* admin right. The `language_iso` is the identifer of one of the system languages. You are only required to include the `language_iso` attribute, however you may override the default language code, language name and plural forms as well. Requires <code>write_languages</code> OAuth access scope.

Creates one or more languages in the project. Requires *Manage languages* admin right. The `language_iso` is the identifer of one of the system languages. You are only required to include the `language_iso` attribute, however you may override the default language code, language name and plural forms as well. Requires <code>write_languages</code> OAuth access scope.

Authentication

Connected account required

Tags

Languages
Create screenshotsLOKALISE_CREATE_SCREENSHOTSCreates one or more screenshots in the project. Requires *Manage screenshots* admin right. Requires <code>write_screenshots</code> OAuth access scope.

Creates one or more screenshots in the project. Requires *Manage screenshots* admin right. Requires <code>write_screenshots</code> OAuth access scope.

Authentication

Connected account required

Tags

Screenshots
Create a service JWT tokenLOKALISE_CREATE_SERVICE_JWTCreate a JWT token for working with other services (primarily OTA/mobile SDKs). **Project Type Compatibility:** - ✅ **Software projects** (localization_files) - *Used with mobile SDKs and OTA updates* - ❌ **Documents projects** (paged_documents) - *Not supported* - ❌ **Marketing projects** (content_integration, marketing, marketing_integrations) - *Not supported*

Create a JWT token for working with other services (primarily OTA/mobile SDKs). **Project Type Compatibility:** - ✅ **Software projects** (localization_files) - *Used with mobile SDKs and OTA updates* - ❌ **Documents projects** (paged_documents) - *Not supported* - ❌ **Marketing projects** (content_integration, marketing, marketing_integrations) - *Not supported*

Authentication

Connected account required

Tags

JWT tokens
Create team user billing detailsLOKALISE_CREATE_TEAM_USER_BILLING_DETAILSCreates a [Team user billing details](#object-team-user-billing-details) object. Requires <code>write_team_user_billing_details</code> OAuth access scope.

Creates a [Team user billing details](#object-team-user-billing-details) object. Requires <code>write_team_user_billing_details</code> OAuth access scope.

Authentication

Connected account required

Tags

Team User Billing Details
Delete a cardLOKALISE_DELETE_A_CARDDeletes a payment card from user cards. Requires <code>write_payment_cards</code> OAuth access scope.

Deletes a payment card from user cards. Requires <code>write_payment_cards</code> OAuth access scope.

Authentication

Connected account required

Tags

Payment Cards
Delete a commentLOKALISE_DELETE_A_COMMENTDeletes a comment from the project. Authenticated user can only delete own comments. Requires <code>write_comments</code> OAuth access scope.

Deletes a comment from the project. Authenticated user can only delete own comments. Requires <code>write_comments</code> OAuth access scope.

Authentication

Connected account required

Tags

Comments
Delete a contributorLOKALISE_DELETE_A_CONTRIBUTORDeletes a user from the project. Requires *Manage contributors* admin right. Requires <code>delete_contributors</code> OAuth access scope.

Deletes a user from the project. Requires *Manage contributors* admin right. Requires <code>delete_contributors</code> OAuth access scope.

Authentication

Connected account required

Tags

Contributors
Delete a fileLOKALISE_DELETE_A_FILEDeletes a file and its associated keys from the project. **Project Type Compatibility:** - ✅ **Documents projects** (paged_documents) - ✅ **Marketing projects** (content_integration, marketing, marketing_integrations) - ❌ **Software projects** (localization_files) - *Not supported* Requires <code>write_files</code> OAuth access scope.

Deletes a file and its associated keys from the project. **Project Type Compatibility:** - ✅ **Documents projects** (paged_documents) - ✅ **Marketing projects** (content_integration, marketing, marketing_integrations) - ❌ **Software projects** (localization_files) - *Not supported* Requires <code>write_files</code> OAuth access scope.

Authentication

Connected account required

Tags

Files
Delete a groupLOKALISE_DELETE_A_GROUPDeletes a group from the team. Requires *Admin* right in the team. Requires <code>write_team_groups</code> OAuth access scope.

Deletes a group from the team. Requires *Admin* right in the team. Requires <code>write_team_groups</code> OAuth access scope.

Authentication

Connected account required

Tags

Team Groups
Delete a keyLOKALISE_DELETE_A_KEYDeletes a key from the project. Requires *Manage keys* admin right. **Project Type Compatibility:** - ✅ **Software projects** (localization_files) - ✅ **Marketing projects** (content_integration, marketing, marketing_integrations) - ❌ **Documents projects** (paged_documents) - *Individual key deletion not supported. Keys are managed through file operations.* Requires <code>delete_keys</code> OAuth access scope.

Deletes a key from the project. Requires *Manage keys* admin right. **Project Type Compatibility:** - ✅ **Software projects** (localization_files) - ✅ **Marketing projects** (content_integration, marketing, marketing_integrations) - ❌ **Documents projects** (paged_documents) - *Individual key deletion not supported. Keys are managed through file operations.* Requires <code>delete_keys</code> OAuth access scope.

Authentication

Connected account required

Tags

Keys
Delete a languageLOKALISE_DELETE_A_LANGUAGEDeletes a language from the project. Requires *Manage languages* admin right. Requires <code>write_languages</code> OAuth access scope.

Deletes a language from the project. Requires *Manage languages* admin right. Requires <code>write_languages</code> OAuth access scope.

Authentication

Connected account required

Tags

Languages
Delete a projectLOKALISE_DELETE_A_PROJECTDeletes a project. Requires <code>write_projects</code> OAuth access scope.

Deletes a project. Requires <code>write_projects</code> OAuth access scope.

Authentication

Connected account required

Tags

Projects
Delete a screenshotLOKALISE_DELETE_A_SCREENSHOTDeletes a screenshot from the project. Requires *Manage screenshots* admin right. Requires <code>write_screenshots</code> OAuth access scope.

Deletes a screenshot from the project. Requires *Manage screenshots* admin right. Requires <code>write_screenshots</code> OAuth access scope.

Authentication

Connected account required

Tags

Screenshots
Delete a snapshotLOKALISE_DELETE_A_SNAPSHOTDeletes project snapshot. Requires *Manage settings* admin right. Requires <code>write_snapshots</code> OAuth access scope.

Deletes project snapshot. Requires *Manage settings* admin right. Requires <code>write_snapshots</code> OAuth access scope.

Authentication

Connected account required

Tags

Snapshots
Delete a statusLOKALISE_DELETE_A_STATUSDeletes aa custom translation status. Requires <code>write_custom_translation_statuses</code> OAuth access scope.

Deletes aa custom translation status. Requires <code>write_custom_translation_statuses</code> OAuth access scope.

Authentication

Connected account required

Tags

Custom Translation Statuses
Delete a taskLOKALISE_DELETE_A_TASKDeletes a task from the project. Requires *Manage tasks* admin right. Requires <code>write_tasks</code> OAuth access scope.

Deletes a task from the project. Requires *Manage tasks* admin right. Requires <code>write_tasks</code> OAuth access scope.

Authentication

Connected account required

Tags

Tasks
Delete a team userLOKALISE_DELETE_A_TEAM_USERDeletes a user from the team. Requires *Admin* role in the team. Requires <code>write_team_users</code> OAuth access scope.

Deletes a user from the team. Requires *Admin* role in the team. Requires <code>write_team_users</code> OAuth access scope.

Authentication

Connected account required

Tags

Team Users
Delete a webhookLOKALISE_DELETE_A_WEBHOOKDeletes a configured webhook in the project. Requires *Manage settings* admin right. Requires <code>write_webhooks</code> OAuth access scope.

Deletes a configured webhook in the project. Requires *Manage settings* admin right. Requires <code>write_webhooks</code> OAuth access scope.

Authentication

Connected account required

Tags

Webhooks
Delete all contributorsLOKALISE_DELETE_ALL_CONTRIBUTORSInitiates asynchronous deletion of all contributors from the project. Returns a job ID that can be used to track the deletion progress. Requires *Manage contributors* admin right. Requires <code>delete_contributors</code> OAuth access scope. Note: This endpoint returns HTTP 202 (Accepted) upon successful job creation. Use the returned job ID with the job status endpoint to track progress.

Initiates asynchronous deletion of all contributors from the project. Returns a job ID that can be used to track the deletion progress. Requires *Manage contributors* admin right. Requires <code>delete_contributors</code> OAuth access scope. Note: This endpoint returns HTTP 202 (Accepted) upon successful job creation. Use the returned job ID with the job status endpoint to track progress.

Authentication

Connected account required

Tags

Contributors
Delete glossary termsLOKALISE_DELETE_GLOSSARY_TERMSDeletes all glossary terms from the project. Requires *Manage glossary* admin right. Requires <code>write_glossary</code> OAuth access scope.

Deletes all glossary terms from the project. Requires *Manage glossary* admin right. Requires <code>write_glossary</code> OAuth access scope.

Authentication

Connected account required

Tags

Glossary
Delete multiple keysLOKALISE_DELETE_MULTIPLE_KEYSDeletes multiple keys from the project. Requires *Manage keys* admin right. Requires <code>write_keys</code> OAuth access scope.

Deletes multiple keys from the project. Requires *Manage keys* admin right. Requires <code>write_keys</code> OAuth access scope.

Authentication

Connected account required

Tags

Keys
Download filesLOKALISE_DOWNLOAD_FILESExports project files as a .zip bundle. Generated bundle will be uploaded to an Amazon S3 bucket, which will be stored there for 1 month available to download. As the bundle is generated and uploaded you would get a response with the URL to the file. Requires *Download files* admin right. There are two ways to group keys by filenames when you are exporting - either all keys to a single file per language or use the previously assigned filenames. <a href="https://developers.lokalise.com/docs/webhooks-guide" target="`_new`">Learn more</a>. Requires <code>read_files</code> OAuth access scope. *Please note: Starting June 1st, 2025, this endpoint will be limited to projects with under 10,000 key-language pairs, for more details <a href="https://developers.lokalise.com/reference/file-download-limitations" target="`_new`">See our API limits page</a>*

Exports project files as a .zip bundle. Generated bundle will be uploaded to an Amazon S3 bucket, which will be stored there for 1 month available to download. As the bundle is generated and uploaded you would get a response with the URL to the file. Requires *Download files* admin right. There are two ways to group keys by filenames when you are exporting - either all keys to a single file per language or use the previously assigned filenames. <a href="https://developers.lokalise.com/docs/webhooks-guide" target="`_new`">Learn more</a>. Requires <code>read_files</code> OAuth access scope. *Please note: Starting June 1st, 2025, this endpoint will be limited to projects with under 10,000 key-language pairs, for more details <a href="https://developers.lokalise.com/reference/file-download-limitations" target="`_new`">See our API limits page</a>*

Authentication

Connected account required

Tags

Files
Download files (Async)LOKALISE_DOWNLOAD_FILES_ASYNCStarts a project export process. The progress of the process can be tracked using the <a href="https://developers.lokalise.com/reference/list-all-processes">list all processes</a> API endpoint. Once complete, the download URL can be accessed using the <a href="https://developers.lokalise.com/reference/retrieve-a-process">Retrieve process</a> API endpoint. For general details about the Download endpoint, please refer to the <a href="https://developers.lokalise.com/reference/download-files">Download files</a> API endpoint.

Starts a project export process. The progress of the process can be tracked using the <a href="https://developers.lokalise.com/reference/list-all-processes">list all processes</a> API endpoint. Once complete, the download URL can be accessed using the <a href="https://developers.lokalise.com/reference/retrieve-a-process">Retrieve process</a> API endpoint. For general details about the Download endpoint, please refer to the <a href="https://developers.lokalise.com/reference/download-files">Download files</a> API endpoint.

Authentication

Connected account required

Tags

Files
Empty a projectLOKALISE_EMPTY_A_PROJECTDeletes all keys and translations from the project. Requires *Manage settings* admin right. Requires <code>write_projects</code> OAuth access scope.

Deletes all keys and translations from the project. Requires *Manage settings* admin right. Requires <code>write_projects</code> OAuth access scope.

Authentication

Connected account required

Tags

Projects
Get bulk deletion job statusLOKALISE_GET_BULK_DELETION_JOB_STATUSRetrieves the status of a bulk contributors deletion job. Use the job ID returned from the bulk delete endpoint. Requires <code>read_contributors</code> OAuth access scope.

Retrieves the status of a bulk contributors deletion job. Use the job ID returned from the bulk delete endpoint. Requires <code>read_contributors</code> OAuth access scope.

Authentication

Connected account required

Tags

Contributors
Get team detailsLOKALISE_GET_TEAM_DETAILSGet details of a specific team. Requires <code>read_team_users</code> OAuth access scope.

Get details of a specific team. Requires <code>read_team_users</code> OAuth access scope.

Authentication

Connected account required

Tags

Teams
Import contributorsLOKALISE_IMPORT_CONTRIBUTORSImports contributors from one project to another, copying their roles, permissions, and language assignments. If `contributor_ids` is omitted or empty, all contributors from the source project will be imported. If specified, only the listed contributors will be imported. Requires *Manage contributors* admin right on target project and read access to source project. Requires <code>write_contributors</code> OAuth access scope.

Imports contributors from one project to another, copying their roles, permissions, and language assignments. If `contributor_ids` is omitted or empty, all contributors from the source project will be imported. If specified, only the listed contributors will be imported. Requires *Manage contributors* admin right on target project and read access to source project. Requires <code>write_contributors</code> OAuth access scope.

Authentication

Connected account required

Tags

Contributors
List all cardsLOKALISE_LIST_ALL_CARDSLists all user payment cards. Requires <code>read_payment_cards</code> OAuth access scope.

Lists all user payment cards. Requires <code>read_payment_cards</code> OAuth access scope.

Authentication

Connected account required

Tags

Payment Cards
List all contributorsLOKALISE_LIST_ALL_CONTRIBUTORSLists contributors of the project, including access levels to the project languages. Admins always have read/write access to all languages. Requires <code>read_contributors</code> OAuth access scope.

Lists contributors of the project, including access levels to the project languages. Admins always have read/write access to all languages. Requires <code>read_contributors</code> OAuth access scope.

Authentication

Connected account required

Tags

Contributors
List all filesLOKALISE_LIST_ALL_FILESLists project files and associated key count. If there are some keys in the project that do not have a file association, they will be returned with filename `__unassigned__`. Requires <code>read_files</code> OAuth access scope.

Lists project files and associated key count. If there are some keys in the project that do not have a file association, they will be returned with filename `__unassigned__`. Requires <code>read_files</code> OAuth access scope.

Authentication

Connected account required

Tags

Files
List all groupsLOKALISE_LIST_ALL_GROUPSLists all user groups in the team. Requires <code>read_team_groups</code> OAuth access scope.

Lists all user groups in the team. Requires <code>read_team_groups</code> OAuth access scope.

Authentication

Connected account required

Tags

Team Groups
List all keysLOKALISE_LIST_ALL_KEYSLists all keys in the project. This endpoint supports cursor pagination for better performance with large datasets. When using cursor pagination, the response will include a <code>nextCursor</code> value in the response headers when more data is available. Continue making requests with the <code>nextCursor</code> value until no <code>nextCursor</code> is returned, indicating all data has been retrieved. <b>IMPORTANT:</b> We do not provide a content delivery network for your language files. Do not make a request to this endpoint every time a user visits your website/app. Instead, fetch the results from this endpoint from time to time, store them locally, and serve your visitors with static files/your database content. Alternatively, you may use our File Download endpoint with an Amazon S3/Google CouldStorage integration to automatically upload your language files to a bucket of your choice. Requires <code>read_keys</code> OAuth access scope.

Lists all keys in the project. This endpoint supports cursor pagination for better performance with large datasets. When using cursor pagination, the response will include a <code>nextCursor</code> value in the response headers when more data is available. Continue making requests with the <code>nextCursor</code> value until no <code>nextCursor</code> is returned, indicating all data has been retrieved. <b>IMPORTANT:</b> We do not provide a content delivery network for your language files. Do not make a request to this endpoint every time a user visits your website/app. Instead, fetch the results from this endpoint from time to time, store them locally, and serve your visitors with static files/your database content. Alternatively, you may use our File Download endpoint with an Amazon S3/Google CouldStorage integration to automatically upload your language files to a bucket of your choice. Requires <code>read_keys</code> OAuth access scope.

Authentication

Connected account required

Tags

Keys
List all ordersLOKALISE_LIST_ALL_ORDERSLists all translation orders in the team. Requires <code>read_team_orders</code> OAuth access scope.

Lists all translation orders in the team. Requires <code>read_team_orders</code> OAuth access scope.

Authentication

Connected account required

Tags

Orders
List all permission templates for particular teamLOKALISE_LIST_ALL_PERMISSION_TEMPLATESList all permission templates for particular team to assign to contributor/group

List all permission templates for particular team to assign to contributor/group

Authentication

Connected account required

Tags

Permission Templates
List all processesLOKALISE_LIST_ALL_PROCESSESRetrieves a list of [Queued process](#object-queued-processes) objects. Requires <code>read_background_processes</code> OAuth access scope.

Retrieves a list of [Queued process](#object-queued-processes) objects. Requires <code>read_background_processes</code> OAuth access scope.

Authentication

Connected account required

Tags

Queued Processes
List all projectsLOKALISE_LIST_ALL_PROJECTSRetrieves a list of projects available to the user, authorized with a token. Requires <code>read_projects</code> OAuth access scope.

Retrieves a list of projects available to the user, authorized with a token. Requires <code>read_projects</code> OAuth access scope.

Authentication

Connected account required

Tags

Projects
List all providersLOKALISE_LIST_ALL_PROVIDERSLists all translation providers. Requires <code>read_team_orders</code> OAuth access scope.

Lists all translation providers. Requires <code>read_team_orders</code> OAuth access scope.

Authentication

Connected account required

Tags

Translation Providers
List all screenshotsLOKALISE_LIST_ALL_SCREENSHOTSRetrieves a list of screenshots from the project. Requires <code>read_screenshots</code> OAuth access scope.

Retrieves a list of screenshots from the project. Requires <code>read_screenshots</code> OAuth access scope.

Authentication

Connected account required

Tags

Screenshots
List all segments for key languageLOKALISE_LIST_ALL_SEGMENTS_FOR_KEY_LANGUAGERetrieves a list of key segment items.

Retrieves a list of key segment items.

Authentication

Connected account required

Tags

Segments
List all snapshotsLOKALISE_LIST_ALL_SNAPSHOTSRetrieves a list of project snapshots. Requires *Manage settings* admin right. Requires <code>read_snapshots</code> OAuth access scope.

Retrieves a list of project snapshots. Requires *Manage settings* admin right. Requires <code>read_snapshots</code> OAuth access scope.

Authentication

Connected account required

Tags

Snapshots
List all statusesLOKALISE_LIST_ALL_STATUSESLists all custom translation statuses in the project. Requires <code>read_custom_translation_statuses</code> OAuth access scope.

Lists all custom translation statuses in the project. Requires <code>read_custom_translation_statuses</code> OAuth access scope.

Authentication

Connected account required

Tags

Custom Translation Statuses
List all tasksLOKALISE_LIST_ALL_TASKSLists all tasks in the project. Requires <code>read_tasks</code> OAuth access scope.

Lists all tasks in the project. Requires <code>read_tasks</code> OAuth access scope.

Authentication

Connected account required

Tags

Tasks
List all team usersLOKALISE_LIST_ALL_TEAM_USERSLists all team users. Requires *Admin* role in the team. Requires <code>read_team_users</code> OAuth access scope.

Lists all team users. Requires *Admin* role in the team. Requires <code>read_team_users</code> OAuth access scope.

Authentication

Connected account required

Tags

Team Users
List all teamsLOKALISE_LIST_ALL_TEAMSLists all teams available to the user. Requires <code>read_team_users</code> OAuth access scope.

Lists all teams available to the user. Requires <code>read_team_users</code> OAuth access scope.

Authentication

Connected account required

Tags

Teams
List all translationsLOKALISE_LIST_ALL_TRANSLATIONSRetrieves a list of project translation items, ungrouped. This endpoint supports cursor pagination for better performance with large datasets. When using cursor pagination, the response will include a <code>nextCursor</code> value in the response headers when more data is available. Continue making requests with the <code>nextCursor</code> value until no <code>nextCursor</code> is returned, indicating all data has been retrieved. You may want to request [Keys](#resource-keys) resource in order to get the structured key/translation pairs for all languages. Requires <code>read_translations</code> OAuth access scope.

Retrieves a list of project translation items, ungrouped. This endpoint supports cursor pagination for better performance with large datasets. When using cursor pagination, the response will include a <code>nextCursor</code> value in the response headers when more data is available. Continue making requests with the <code>nextCursor</code> value until no <code>nextCursor</code> is returned, indicating all data has been retrieved. You may want to request [Keys](#resource-keys) resource in order to get the structured key/translation pairs for all languages. Requires <code>read_translations</code> OAuth access scope.

Authentication

Connected account required

Tags

Translations
List all webhooksLOKALISE_LIST_ALL_WEBHOOKSRetrieves a list of configured webhooks. Requires *Manage settings* admin right. Requires <code>read_webhooks</code> OAuth access scope.

Retrieves a list of configured webhooks. Requires *Manage settings* admin right. Requires <code>read_webhooks</code> OAuth access scope.

Authentication

Connected account required

Tags

Webhooks
List glossary termsLOKALISE_LIST_GLOSSARY_TERMSRetrieves a list of glossary terms. This endpoint supports cursor pagination for better performance with large datasets. When using cursor pagination, the response will include a <code>nextCursor</code> value in the metadata when more data is available. Continue making requests with the <code>nextCursor</code> value until no <code>nextCursor</code> is returned, indicating all data has been retrieved. Requires <code>read_glossary</code> OAuth access scope.

Retrieves a list of glossary terms. This endpoint supports cursor pagination for better performance with large datasets. When using cursor pagination, the response will include a <code>nextCursor</code> value in the metadata when more data is available. Continue making requests with the <code>nextCursor</code> value until no <code>nextCursor</code> is returned, indicating all data has been retrieved. Requires <code>read_glossary</code> OAuth access scope.

Authentication

Connected account required

Tags

Glossary
List key commentsLOKALISE_LIST_KEY_COMMENTSRetrieves a list of all comments for a key. Requires <code>read_comments</code> OAuth access scope.

Retrieves a list of all comments for a key. Requires <code>read_comments</code> OAuth access scope.

Authentication

Connected account required

Tags

Comments
List project commentsLOKALISE_LIST_PROJECT_COMMENTSRetrieves a list of all comments in the project. Requires <code>read_comments</code> OAuth access scope.

Retrieves a list of all comments in the project. Requires <code>read_comments</code> OAuth access scope.

Authentication

Connected account required

Tags

Comments
List project languagesLOKALISE_LIST_PROJECT_LANGUAGESRetrieves a list of project languages. Requires <code>read_languages</code> OAuth access scope.

Retrieves a list of project languages. Requires <code>read_languages</code> OAuth access scope.

Authentication

Connected account required

Tags

Languages
List project translation memoriesLOKALISE_LIST_PROJECT_TRANSLATION_MEMORIESRetrieves a list of translation memories enabled for the project. Requires <code>read_projects</code> OAuth access scope.

Retrieves a list of translation memories enabled for the project. Requires <code>read_projects</code> OAuth access scope.

Authentication

Connected account required

Tags

Translation Memories
List system languagesLOKALISE_LIST_SYSTEM_LANGUAGESRetrieves a list of system languages. Requires <code>read_languages</code> OAuth access scope.

Retrieves a list of system languages. Requires <code>read_languages</code> OAuth access scope.

Authentication

Connected account required

Tags

Languages
Regenerate a webhook secretLOKALISE_REGENERATE_A_WEBHOOK_SECRETRegenerate a webhook secret. Requires *Manage settings* admin right. Requires <code>write_webhooks</code> OAuth access scope.

Regenerate a webhook secret. Requires *Manage settings* admin right. Requires <code>write_webhooks</code> OAuth access scope.

Authentication

Connected account required

Tags

Webhooks
Remove members from groupLOKALISE_REMOVE_MEMBERS_FROM_GROUPRequires *Admin* right in the team. Requires <code>write_team_groups</code> OAuth access scope.

Requires *Admin* right in the team. Requires <code>write_team_groups</code> OAuth access scope.

Authentication

Connected account required

Tags

Team Groups
Remove projects from groupLOKALISE_REMOVE_PROJECTS_FROM_GROUPRequires *Admin* right in the team. Requires <code>write_team_groups</code> OAuth access scope.

Requires *Admin* right in the team. Requires <code>write_team_groups</code> OAuth access scope.

Authentication

Connected account required

Tags

Team Groups
Restore a snapshotLOKALISE_RESTORE_A_SNAPSHOTRestores project snapshot to a project copy. Requires *Manage settings* admin right and *Admin* role in the team. Requires <code>write_snapshots</code> OAuth access scope.

Restores project snapshot to a project copy. Requires *Manage settings* admin right and *Admin* role in the team. Requires <code>write_snapshots</code> OAuth access scope.

Authentication

Connected account required

Tags

Snapshots
Retrieve a basic user dataLOKALISE_RETRIEVE_A_BASIC_USER_DATA_FOR_LOGGED_IN_USERRetrieves a [User](#object-users) object. Not available via OAuth token. Available via S2S.

Retrieves a [User](#object-users) object. Not available via OAuth token. Available via S2S.

Authentication

Connected account required

Tags

Users
Retrieve a cardLOKALISE_RETRIEVE_A_CARDRetrieves a [Payment card](#object-cards) object. Requires <code>read_payment_cards</code> OAuth access scope.

Retrieves a [Payment card](#object-cards) object. Requires <code>read_payment_cards</code> OAuth access scope.

Authentication

Connected account required

Tags

Payment Cards
Retrieve a commentLOKALISE_RETRIEVE_A_COMMENTRetrieves a [Comment](#object-comments) object. Requires <code>read_comments</code> OAuth access scope.

Retrieves a [Comment](#object-comments) object. Requires <code>read_comments</code> OAuth access scope.

Authentication

Connected account required

Tags

Comments
Retrieve a contributorLOKALISE_RETRIEVE_A_CONTRIBUTORRetrieves a [Contributor](#object-contributors) object. Requires <code>read_contributors</code> OAuth access scope.

Retrieves a [Contributor](#object-contributors) object. Requires <code>read_contributors</code> OAuth access scope.

Authentication

Connected account required

Tags

Contributors
Retrieve a glossary termLOKALISE_RETRIEVE_A_GLOSSARY_TERMRetrieves a [Glossary Term](#object-glossary-terms) object. Requires <code>read_glossary</code> OAuth access scope.

Retrieves a [Glossary Term](#object-glossary-terms) object. Requires <code>read_glossary</code> OAuth access scope.

Authentication

Connected account required

Tags

Glossary
Retrieve a groupLOKALISE_RETRIEVE_A_GROUPRetrieves a [User group](#object-user-groups) object. Requires <code>read_team_groups</code> OAuth access scope.

Retrieves a [User group](#object-user-groups) object. Requires <code>read_team_groups</code> OAuth access scope.

Authentication

Connected account required

Tags

Team Groups
Retrieve a keyLOKALISE_RETRIEVE_A_KEYRetrieves a [Key](#object-keys) object. Requires <code>read_keys</code> OAuth access scope.

Retrieves a [Key](#object-keys) object. Requires <code>read_keys</code> OAuth access scope.

Authentication

Connected account required

Tags

Keys
Retrieve a languageLOKALISE_RETRIEVE_A_LANGUAGERetrieves a [Language](#object-languages) object. Requires <code>read_languages</code> OAuth access scope.

Retrieves a [Language](#object-languages) object. Requires <code>read_languages</code> OAuth access scope.

Authentication

Connected account required

Tags

Languages
Retrieve a processLOKALISE_RETRIEVE_A_PROCESSRetrieves a [Queued process](#object-queued-processes) object with an additional <code>details</code> field containing information for a specific process type. Requires <code>read_background_processes</code> OAuth access scope.

Retrieves a [Queued process](#object-queued-processes) object with an additional <code>details</code> field containing information for a specific process type. Requires <code>read_background_processes</code> OAuth access scope.

Authentication

Connected account required

Tags

Queued Processes
Retrieve a projectLOKALISE_RETRIEVE_A_PROJECTRetrieves a [Project](#object-projects) object. Requires <code>read_projects</code> OAuth access scope.

Retrieves a [Project](#object-projects) object. Requires <code>read_projects</code> OAuth access scope.

Authentication

Connected account required

Tags

Projects
Retrieve a providerLOKALISE_RETRIEVE_A_PROVIDERRetrieves a [Translation provider](#object-providers) object with tiers and available language pairs. Requires <code>read_team_orders</code> OAuth access scope.

Retrieves a [Translation provider](#object-providers) object with tiers and available language pairs. Requires <code>read_team_orders</code> OAuth access scope.

Authentication

Connected account required

Tags

Translation Providers
Retrieve a screenshotLOKALISE_RETRIEVE_A_SCREENSHOTRetrieves a [Screenshot](#object-screenshots) object. Requires <code>read_screenshots</code> OAuth access scope.

Retrieves a [Screenshot](#object-screenshots) object. Requires <code>read_screenshots</code> OAuth access scope.

Authentication

Connected account required

Tags

Screenshots
Retrieve a segment for key languageLOKALISE_RETRIEVE_A_SEGMENT_FOR_KEY_LANGUAGERetrieves a [Segment](#object-segments) object.

Retrieves a [Segment](#object-segments) object.

Authentication

Connected account required

Tags

Segments
Retrieve a statusLOKALISE_RETRIEVE_A_STATUSRetrieves a [Custom Translation Status](#object-translation-statuses) object. Requires <code>read_custom_translation_statuses</code> OAuth access scope.

Retrieves a [Custom Translation Status](#object-translation-statuses) object. Requires <code>read_custom_translation_statuses</code> OAuth access scope.

Authentication

Connected account required

Tags

Custom Translation Statuses
Retrieve a taskLOKALISE_RETRIEVE_A_TASKRetrieves a [Task](#object-tasks) object. Requires <code>read_tasks</code> OAuth access scope.

Retrieves a [Task](#object-tasks) object. Requires <code>read_tasks</code> OAuth access scope.

Authentication

Connected account required

Tags

Tasks
Retrieve a team userLOKALISE_RETRIEVE_A_TEAM_USERRetrieves a [Team user](#object-team-users) object. Requires *Admin* role in the team. Requires <code>read_team_users</code> OAuth access scope.

Retrieves a [Team user](#object-team-users) object. Requires *Admin* role in the team. Requires <code>read_team_users</code> OAuth access scope.

Authentication

Connected account required

Tags

Team Users
Retrieve a translationLOKALISE_RETRIEVE_A_TRANSLATIONRetrieves a [Translation](#object-translations) object. Requires <code>read_translations</code> OAuth access scope.

Retrieves a [Translation](#object-translations) object. Requires <code>read_translations</code> OAuth access scope.

Authentication

Connected account required

Tags

Translations
Retrieve a webhookLOKALISE_RETRIEVE_A_WEBHOOKRetrieves a [Webhook](#object-webhooks) object. Requires *Manage settings* admin right. Requires <code>read_webhooks</code> OAuth access scope.

Retrieves a [Webhook](#object-webhooks) object. Requires *Manage settings* admin right. Requires <code>read_webhooks</code> OAuth access scope.

Authentication

Connected account required

Tags

Webhooks
Retrieve an orderLOKALISE_RETRIEVE_AN_ORDERRetrieves an [Order](#object-orders) object. Requires <code>read_team_orders</code> OAuth access scope.

Retrieves an [Order](#object-orders) object. Requires <code>read_team_orders</code> OAuth access scope.

Authentication

Connected account required

Tags

Orders
Retrieve available colorsLOKALISE_RETRIEVE_AVAILABLE_COLORSRetrieves an array of available colors that can be assigned to custom translation statuses. Requires <code>read_custom_translation_statuses</code> OAuth access scope.

Retrieves an array of available colors that can be assigned to custom translation statuses. Requires <code>read_custom_translation_statuses</code> OAuth access scope.

Authentication

Connected account required

Tags

Custom Translation Statuses
Retrieve a contributor representing user sending a queryLOKALISE_RETRIEVE_ME_AS_A_CONTRIBUTORRetrieves a [Contributor](#object-contributors) object. Gets combined permissions from contributor and a group. Requires <code>read_contributors</code> OAuth access scope.

Retrieves a [Contributor](#object-contributors) object. Gets combined permissions from contributor and a group. Requires <code>read_contributors</code> OAuth access scope.

Authentication

Connected account required

Tags

Contributors
Retrieve task usage metricsLOKALISE_RETRIEVE_TASK_USAGE_METRICSRetrieves usage metrics for a specific task. Data is available from November 3rd 2025 onwards. Requires <code>read_tasks</code> OAuth access scope.

Retrieves usage metrics for a specific task. Data is available from November 3rd 2025 onwards. Requires <code>read_tasks</code> OAuth access scope.

Authentication

Connected account required

Tags

Tasks
Retrieve team user billing detailsLOKALISE_RETRIEVE_TEAM_USER_BILLING_DETAILSRetrieve a [Team user billing details](#object-team-user-billing-details) object. Requires <code>read_team_user_billing_details</code> OAuth access scope.

Retrieve a [Team user billing details](#object-team-user-billing-details) object. Requires <code>read_team_user_billing_details</code> OAuth access scope.

Authentication

Connected account required

Tags

Team User Billing Details
Update a contributorLOKALISE_UPDATE_A_CONTRIBUTORUpdates the properties of a contributor. Requires *Manage contributors* admin right. If you want to give an existing contributor access to a new language, you must specify full `languages` array, including the previously added languages as well. You can pass role_id and permissions will be updated from permission template accordingly, in this case admin_rights param will be ignored Requires <code>write_contributors</code> OAuth access scope.

Updates the properties of a contributor. Requires *Manage contributors* admin right. If you want to give an existing contributor access to a new language, you must specify full `languages` array, including the previously added languages as well. You can pass role_id and permissions will be updated from permission template accordingly, in this case admin_rights param will be ignored Requires <code>write_contributors</code> OAuth access scope.

Authentication

Connected account required

Tags

Contributors
Update a groupLOKALISE_UPDATE_A_GROUPUpdates the properties of a group. Requires *Admin* right in the team. Requires <code>write_team_groups</code> OAuth access scope.

Updates the properties of a group. Requires *Admin* right in the team. Requires <code>write_team_groups</code> OAuth access scope.

Authentication

Connected account required

Tags

Team Groups
Update a keyLOKALISE_UPDATE_A_KEYUpdates the properties of a key and it's associated objects. Requires *Manage keys* admin right. Requires <code>write_keys</code> OAuth access scope.

Updates the properties of a key and it's associated objects. Requires *Manage keys* admin right. Requires <code>write_keys</code> OAuth access scope.

Authentication

Connected account required

Tags

Keys
Update a languageLOKALISE_UPDATE_A_LANGUAGEUpdates the properties of a language. Requires *Manage languages* admin right. Requires <code>write_languages</code> OAuth access scope.

Updates the properties of a language. Requires *Manage languages* admin right. Requires <code>write_languages</code> OAuth access scope.

Authentication

Connected account required

Tags

Languages
Update a projectLOKALISE_UPDATE_A_PROJECTUpdates the details of a project. Requires *Manage settings* admin right. Requires <code>write_projects</code> OAuth access scope.

Updates the details of a project. Requires *Manage settings* admin right. Requires <code>write_projects</code> OAuth access scope.

Authentication

Connected account required

Tags

Projects
Update a screenshotLOKALISE_UPDATE_A_SCREENSHOTUpdates the properties of a screenshot. Requires *Manage screenshots* admin right. Requires <code>write_screenshots</code> OAuth access scope.

Updates the properties of a screenshot. Requires *Manage screenshots* admin right. Requires <code>write_screenshots</code> OAuth access scope.

Authentication

Connected account required

Tags

Screenshots
Update a segmentLOKALISE_UPDATE_A_SEGMENTUpdates a segment.

Updates a segment.

Authentication

Connected account required

Tags

Segments
Update a statusLOKALISE_UPDATE_A_STATUSUpdates the custom translation status. Requires <code>write_custom_translation_statuses</code> OAuth access scope.

Updates the custom translation status. Requires <code>write_custom_translation_statuses</code> OAuth access scope.

Authentication

Connected account required

Tags

Custom Translation Statuses
Update a taskLOKALISE_UPDATE_A_TASKUpdates the properties of a task. Requires *Manage tasks* admin right. Requires <code>write_tasks</code> OAuth access scope.

Updates the properties of a task. Requires *Manage tasks* admin right. Requires <code>write_tasks</code> OAuth access scope.

Authentication

Connected account required

Tags

Tasks
Update a team userLOKALISE_UPDATE_A_TEAM_USERUpdates the role of a team user. Requires *Admin* role in the team. Requires <code>write_team_users</code> OAuth access scope.

Updates the role of a team user. Requires *Admin* role in the team. Requires <code>write_team_users</code> OAuth access scope.

Authentication

Connected account required

Tags

Team Users
Update a translationLOKALISE_UPDATE_A_TRANSLATIONUpdates a translation. Alternatively, use the <a href="/reference/bulk-update">Multi-key update</a> endpoint to update translations. Requires <code>write_translations</code> OAuth access scope.

Updates a translation. Alternatively, use the <a href="/reference/bulk-update">Multi-key update</a> endpoint to update translations. Requires <code>write_translations</code> OAuth access scope.

Authentication

Connected account required

Tags

Translations
Update a webhookLOKALISE_UPDATE_A_WEBHOOKUpdates a configured webhook in the project. Requires *Manage settings* admin right. Requires <code>write_webhooks</code> OAuth access scope.

Updates a configured webhook in the project. Requires *Manage settings* admin right. Requires <code>write_webhooks</code> OAuth access scope.

Authentication

Connected account required

Tags

Webhooks
Update glossary termsLOKALISE_UPDATE_GLOSSARY_TERMSUpdates one or more glossary terms in the project. Requires *Manage glossary* admin right. Requires <code>write_glossary</code> OAuth access scope.

Updates one or more glossary terms in the project. Requires *Manage glossary* admin right. Requires <code>write_glossary</code> OAuth access scope.

Authentication

Connected account required

Tags

Glossary
Update team user billing detailsLOKALISE_UPDATE_TEAM_USER_BILLING_DETAILSUpdates a [Team user billing details](#object-team-user-billing-details) object. Requires <code>write_team_user_billing_details</code> OAuth access scope.

Updates a [Team user billing details](#object-team-user-billing-details) object. Requires <code>write_team_user_billing_details</code> OAuth access scope.

Authentication

Connected account required

Tags

Team User Billing Details
Upload a fileLOKALISE_UPLOAD_A_FILEQueues a localization file for import and returns a <code>202</code> or <code>302</code> response along with a <a href="#object-queued-processes">Queued process</a> object. <a href="https://docs.lokalise.com/developer-docs/uploading-files" target="`_new`">Learn more</a>. Requires *Upload files* admin right. <a href="https://docs.lokalise.com/en/collections/2909229-supported-file-formats" target=_new>Supported file types</a>. Please note that the <code>302</code> response code is not currently used, but in the future it will be returned if the same file is already in the upload queue. Requires <code>write_files</code> OAuth access scope.

Queues a localization file for import and returns a <code>202</code> or <code>302</code> response along with a <a href="#object-queued-processes">Queued process</a> object. <a href="https://docs.lokalise.com/developer-docs/uploading-files" target="`_new`">Learn more</a>. Requires *Upload files* admin right. <a href="https://docs.lokalise.com/en/collections/2909229-supported-file-formats" target=_new>Supported file types</a>. Please note that the <code>302</code> response code is not currently used, but in the future it will be returned if the same file is already in the upload queue. Requires <code>write_files</code> OAuth access scope.

Authentication

Connected account required

Tags

Files