# Lokalise integration

> Localization and translation management platform: projects, keys, translations, files, tasks, contributors, teams and webhooks.

- Authentication: apiKey

## Tools (115)

- **Add members to group**: Requires *Admin* right in the team. Requires `write_team_groups` OAuth access scope.
- **Add projects to group**: Requires *Admin* right in the team. Requires `write_team_groups` OAuth access scope.
- **Create a branch**: Creates a branch in the project. Before using this endpoint, please enable Branching in your project by following [this guide](https://docs.lokalise.com/en/articles/3391861-project-branching).
- **Create a card**: Adds new payment card to user cards. Requires `write_payment_cards` OAuth access scope.
- **Create a group**: Creates a group in the team. Requires *Admin* right in the team.
- **Create an order**: Creates a translation order. You must have admin privileges in the project you are placing an order in. Requires `write_team_orders` OAuth access scope.
- **Create a project**: Creates a new project in the specified team. Requires *Admin* role in the team. Requires `write_projects` OAuth access scope.
- **Create a service JWT token**: Create a JWT token for working with other services (primarily OTA/mobile SDKs).
- **Create a snapshot**: Creates snapshot of the project. Requires *Manage settings* admin right. Requires `write_snapshots` OAuth access scope.
- **Create a status**: Creates a custom translation status in the project. Requires `write_custom_translation_statuses` OAuth access scope.
- **Create a task**: Creates a task in the project. Requires *Manage tasks* admin right. Keep in mind, that `initial_tm_leverage` attribute will be empty in server response.
- **Create a webhook**: Creates a webhook in the project. Requires *Manage settings* admin right. See our documentation (https://docs.lokalise.com/en/articles/3184756-webhooks) for available events and payload examples.
- **Create comments**: Adds a set of comments to the key. Requires `write_comments` OAuth access scope.
- **Create contributors**: Creates one or more contributors in the project. Requires *Manage contributors* admin right.
- **Create glossary terms**: Creates one or more glossary terms in the project. Requires *Manage glossary* admin right. Requires `write_glossary` OAuth access scope.
- **Create keys**: 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 `write_keys` OAuth access scope.
- **Create languages**: 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.
- **Create screenshots**: Creates one or more screenshots in the project. Requires *Manage screenshots* admin right. Requires `write_screenshots` OAuth access scope.
- **Create team user billing details**: Creates a [Team user billing details](#object-team-user-billing-details) object. Requires `write_team_user_billing_details` OAuth access scope.
- **Delete a branch**: Deletes a configured branch in the project. Requires admin right. Requires `write_projects` OAuth access scope.
- **Delete a card**: Deletes a payment card from user cards. Requires `write_payment_cards` OAuth access scope.
- **Delete a comment**: Deletes a comment from the project. Authenticated user can only delete own comments. Requires `write_comments` OAuth access scope.
- **Delete a contributor**: Deletes a user from the project. Requires *Manage contributors* admin right. Requires `delete_contributors` OAuth access scope.
- **Delete a file**: Deletes a file and its associated keys from the project.
- **Delete a group**: Deletes a group from the team. Requires *Admin* right in the team. Requires `write_team_groups` OAuth access scope.
- **Delete a key**: Deletes a key from the project. Requires *Manage keys* admin right.
- **Delete a language**: Deletes a language from the project. Requires *Manage languages* admin right. Requires `write_languages` OAuth access scope.
- **Delete all contributors**: 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.
- **Delete a project**: Deletes a project. Requires `write_projects` OAuth access scope.
- **Delete a screenshot**: Deletes a screenshot from the project. Requires *Manage screenshots* admin right. Requires `write_screenshots` OAuth access scope.
- **Delete a snapshot**: Deletes project snapshot. Requires *Manage settings* admin right. Requires `write_snapshots` OAuth access scope.
- **Delete a status**: Deletes aa custom translation status. Requires `write_custom_translation_statuses` OAuth access scope.
- **Delete a task**: Deletes a task from the project. Requires *Manage tasks* admin right. Requires `write_tasks` OAuth access scope.
- **Delete a team user**: Deletes a user from the team. Requires *Admin* role in the team. Requires `write_team_users` OAuth access scope.
- **Delete a webhook**: Deletes a configured webhook in the project. Requires *Manage settings* admin right. Requires `write_webhooks` OAuth access scope.
- **Delete glossary terms**: Deletes all glossary terms from the project. Requires *Manage glossary* admin right. Requires `write_glossary` OAuth access scope.
- **Delete multiple keys**: Deletes multiple keys from the project. Requires *Manage keys* admin right. Requires `write_keys` OAuth access scope.
- **Download files**: 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.
- **Download files (Async)**: Starts a project export process. The progress of the process can be tracked using the list all processes (https://developers.lokalise.com/reference/list-all-processes) API endpoint.
- **Empty a project**: Deletes all keys and translations from the project. Requires *Manage settings* admin right. Requires `write_projects` OAuth access scope.
- **Get bulk deletion job status**: Retrieves the status of a bulk contributors deletion job. Use the job ID returned from the bulk delete endpoint. Requires `read_contributors` OAuth access scope.
- **Get team details**: Get details of a specific team. Requires `read_team_users` OAuth access scope.
- **Import contributors**: Imports contributors from one project to another, copying their roles, permissions, and language assignments.
- **List all branches**: Retrieves a list of branches.
- **List all cards**: Lists all user payment cards. Requires `read_payment_cards` OAuth access scope.
- **List all contributors**: Lists contributors of the project, including access levels to the project languages. Admins always have read/write access to all languages. Requires `read_contributors` OAuth access scope.
- **List all files**: 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__`.
- **List all groups**: Lists all user groups in the team. Requires `read_team_groups` OAuth access scope.
- **List all keys**: Lists all keys in the project. This endpoint supports cursor pagination for better performance with large datasets.
- **List all orders**: Lists all translation orders in the team. Requires `read_team_orders` OAuth access scope.
- **List all permission templates for particular team**: List all permission templates for particular team to assign to contributor/group
- **List all processes**: Retrieves a list of [Queued process](#object-queued-processes) objects. Requires `read_background_processes` OAuth access scope.
- **List all projects**: Retrieves a list of projects available to the user, authorized with a token. This endpoint supports cursor pagination for better performance with large datasets.
- **List all providers**: Lists all translation providers. Requires `read_team_orders` OAuth access scope.
- **List all screenshots**: Retrieves a list of screenshots from the project. Requires `read_screenshots` OAuth access scope.
- **List all segments for key language**: Retrieves a list of key segment items.
- **List all snapshots**: Retrieves a list of project snapshots. Requires *Manage settings* admin right. Requires `read_snapshots` OAuth access scope.
- **List all statuses**: Lists all custom translation statuses in the project. Requires `read_custom_translation_statuses` OAuth access scope.
- **List all tasks**: Lists all tasks in the project. Requires `read_tasks` OAuth access scope.
- **List all teams**: Lists all teams available to the user. Requires `read_team_users` OAuth access scope.
- **List all team users**: Lists all team users. Requires *Admin* role in the team. Requires `read_team_users` OAuth access scope.
- **List all translations**: Retrieves a list of project translation items, ungrouped. This endpoint supports cursor pagination for better performance with large datasets.
- **List all webhooks**: Retrieves a list of configured webhooks. Requires *Manage settings* admin right. Requires `read_webhooks` OAuth access scope.
- **List glossary terms**: Retrieves a list of glossary terms. This endpoint supports cursor pagination for better performance with large datasets.
- **List key comments**: Retrieves a list of all comments for a key. Requires `read_comments` OAuth access scope.
- **List project comments**: Retrieves a list of all comments in the project. Requires `read_comments` OAuth access scope.
- **List project languages**: Retrieves a list of project languages. Requires `read_languages` OAuth access scope.
- **List project translation memories**: Retrieves a list of translation memories enabled for the project. Requires `read_projects` OAuth access scope.
- **List system languages**: Retrieves a list of system languages. Requires `read_languages` OAuth access scope.
- **Merge a branch**: Merges a branch in the project. Requires admin right. Requires `write_projects` OAuth access scope.
- **Multi-update**: Updates one or more keys in the project. Requires *Manage keys* admin right.
- **Regenerate a webhook secret**: Regenerate a webhook secret. Requires *Manage settings* admin right. Requires `write_webhooks` OAuth access scope.
- **Remove members from group**: Requires *Admin* right in the team. Requires `write_team_groups` OAuth access scope.
- **Remove projects from group**: Requires *Admin* right in the team. Requires `write_team_groups` OAuth access scope.
- **Restore a snapshot**: Restores project snapshot to a project copy. Requires *Manage settings* admin right and *Admin* role in the team. Requires `write_snapshots` OAuth access scope.
- **Retrieve a basic user data**: Retrieves a [User](#object-users) object. Not available via OAuth token. Available via S2S.
- **Retrieve a branch**: Retrieves a [Branch](#object-branches) object. Requires `read_projects` OAuth access scope.
- **Retrieve a card**: Retrieves a [Payment card](#object-cards) object. Requires `read_payment_cards` OAuth access scope.
- **Retrieve a comment**: Retrieves a [Comment](#object-comments) object. Requires `read_comments` OAuth access scope.
- **Retrieve a contributor**: Retrieves a [Contributor](#object-contributors) object. Requires `read_contributors` OAuth access scope.
- **Retrieve a contributor representing user sending a query**: Retrieves a [Contributor](#object-contributors) object. Gets combined permissions from contributor and a group. Requires `read_contributors` OAuth access scope.
- **Retrieve a glossary term**: Retrieves a [Glossary Term](#object-glossary-terms) object. Requires `read_glossary` OAuth access scope.
- **Retrieve a group**: Retrieves a [User group](#object-user-groups) object. Requires `read_team_groups` OAuth access scope.
- **Retrieve a key**: Retrieves a [Key](#object-keys) object. Requires `read_keys` OAuth access scope.
- **Retrieve a language**: Retrieves a [Language](#object-languages) object. Requires `read_languages` OAuth access scope.
- **Retrieve an order**: Retrieves an [Order](#object-orders) object. Requires `read_team_orders` OAuth access scope.
- **Retrieve a process**: Retrieves a [Queued process](#object-queued-processes) object with an additional `details` field containing information for a specific process type.
- **Retrieve a project**: Retrieves a [Project](#object-projects) object. Requires `read_projects` OAuth access scope.
- **Retrieve a provider**: Retrieves a [Translation provider](#object-providers) object with tiers and available language pairs. Requires `read_team_orders` OAuth access scope.
- **Retrieve a screenshot**: Retrieves a [Screenshot](#object-screenshots) object. Requires `read_screenshots` OAuth access scope.
- **Retrieve a segment for key language**: Retrieves a [Segment](#object-segments) object.
- **Retrieve a status**: Retrieves a [Custom Translation Status](#object-translation-statuses) object. Requires `read_custom_translation_statuses` OAuth access scope.
- **Retrieve a task**: Retrieves a [Task](#object-tasks) object. Requires `read_tasks` OAuth access scope.
- **Retrieve a team user**: Retrieves a [Team user](#object-team-users) object. Requires *Admin* role in the team. Requires `read_team_users` OAuth access scope.
- **Retrieve a translation**: Retrieves a [Translation](#object-translations) object. Requires `read_translations` OAuth access scope.
- **Retrieve available colors**: Retrieves an array of available colors that can be assigned to custom translation statuses. Requires `read_custom_translation_statuses` OAuth access scope.
- **Retrieve a webhook**: Retrieves a [Webhook](#object-webhooks) object. Requires *Manage settings* admin right. Requires `read_webhooks` OAuth access scope.
- **Retrieve task usage metrics**: Retrieves usage metrics for a specific task. Data is available from November 3rd 2025 onwards. Requires `read_tasks` OAuth access scope.
- **Retrieve team user billing details**: Retrieve a [Team user billing details](#object-team-user-billing-details) object. Requires `read_team_user_billing_details` OAuth access scope.
- **Update a branch**: Updates a branch in the project. Requires admin right. Requires `write_projects` OAuth access scope.
- **Update a contributor**: Updates the properties of a contributor. Requires *Manage contributors* admin right.
- **Update a group**: Updates the properties of a group. Requires *Admin* right in the team. Requires `write_team_groups` OAuth access scope.
- **Update a key**: Updates the properties of a key and it's associated objects. Requires *Manage keys* admin right.
- **Update a language**: Updates the properties of a language. Requires *Manage languages* admin right. Requires `write_languages` OAuth access scope.
- **Update a project**: Updates the details of a project. Requires *Manage settings* admin right. Requires `write_projects` OAuth access scope.
- **Update a screenshot**: Updates the properties of a screenshot. Requires *Manage screenshots* admin right. Requires `write_screenshots` OAuth access scope.
- **Update a segment**: Updates a segment.
- **Update a status**: Updates the custom translation status. Requires `write_custom_translation_statuses` OAuth access scope.
- **Update a task**: Updates the properties of a task. Requires *Manage tasks* admin right. Requires `write_tasks` OAuth access scope.
- **Update a team user**: Updates the role of a team user. Requires *Admin* role in the team. Requires `write_team_users` OAuth access scope.
- **Update a translation**: Updates a translation. Alternatively, use the Multi-key update (/reference/bulk-update) endpoint to update translations. Requires `write_translations` OAuth access scope.
- **Update a webhook**: Updates a configured webhook in the project. Requires *Manage settings* admin right. Requires `write_webhooks` OAuth access scope.
- **Update glossary terms**: Updates one or more glossary terms in the project. Requires *Manage glossary* admin right. Requires `write_glossary` OAuth access scope.
- **Update team user billing details**: Updates a [Team user billing details](#object-team-user-billing-details) object. Requires `write_team_user_billing_details` OAuth access scope.
- **Upload a file**: Queues a localization file for import and returns a `202` or `302` response along with a Queued process (#object-queued-processes) object.

Connect Lokalise in General Input: https://www.generalinput.com/apps/lokalise