---
canonical_url: "https://docs.composio.dev/toolkits/lokalise"
markdown_url: "https://docs.composio.dev/toolkits/lokalise.md"
product: "platform"
version: null
last_updated: null
---

# Lokalise

Lokalise is a translation and localization management platform for managing multilingual content, projects, contributors, files, keys, translations, and localization workflows.

- **Category:** project management
- **Auth:** API_KEY
- **Composio-managed OAuth available?** N/A
- **Tools:** 10
- **Triggers:** 0
- **Slug:** `LOKALISE`
- **Version:** 00000000_00

## Tools

### Create Keys

**Slug:** `LOKALISE_CREATE_KEYS`

Create 1 to 500 keys in a Lokalise project or branch. Requires a personal read/write API token and the project's Manage keys admin right. Branch targets also require a compatible Software project with Branching enabled. The response retains per-item errors so partial batch failures remain visible.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `keys` | array | Yes | Keys to create in this batch; Lokalise supports at most 500 per request. |
| `project_id` | string | Yes | Lokalise project ID. |
| `branch_name` | string | No | Branch name; omit for the default project. Requires a compatible Software project with Branching enabled. |
| `use_automations` | boolean | No | Run project automations on translations created with these keys. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Keys

**Slug:** `LOKALISE_DELETE_KEYS`

Permanently delete one or more keys from a Lokalise project or branch. This operation is irreversible and requires a personal read/write API token with key-management permission. Branch targets additionally require a compatible Software project with Branching enabled.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `key_ids` | array | Yes | One or more key IDs to permanently delete. The IDs are sent as strings in Lokalise's required DELETE JSON body. |
| `project_id` | string | Yes | Lokalise project ID containing the keys to delete. |
| `branch_name` | string | No | Branch name. Omit for the default project; when set, the project must be a branch-enabled Software project. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Audit Logs

**Slug:** `LOKALISE_LIST_AUDIT_LOGS`

List one page of team audit events in OCSF 1.3.0 format. This endpoint requires a personal API token belonging to a team admin and a Lokalise plan that includes Audit Logs; availability was verified on Trial. The response intentionally excludes source IP, request URL, user-agent, session, and other unnecessary personal or network details.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum audit events to return in this page (1-1000). |
| `date_to` | string | No | Latest UTC date to include, in YYYY-MM-DD format; must not precede date_from. |
| `user_id` | integer | No | Numeric ID of the user who initiated the event. |
| `date_from` | string | No | Earliest UTC date to include, in YYYY-MM-DD format. |
| `event_type` | string ("team.created" | "team.updated" | "team.changed" | "team.cleanup.finished" | "team.security.settings.updated" | "team.billing.details.updated" | "team.downloaded.invoices.bulk" | "team.member.added" | "team.member.updated" | "team.member.deleted" | "user.group.created" | "user.group.updated" | "user.group.deleted" | "user.group.member.added" | "user.group.member.deleted" | "user.group.project.added" | "user.group.project.removed" | "user.group.language.added" | "user.group.language.updated" | "user.group.language.deleted" | "user.group.access.modified" | "user.group.admin.permissions.enabled" | "user.group.admin.permissions.updated" | "user.group.admin.permissions.disabled" | "team.translation.memory.created" | "team.translation.memory.uploaded" | "team.translation.memory.updated" | "team.translation.memory.cleared" | "team.translation.memory.deleted" | "team.subscription.subscribed" | "team.subscription.changed" | "team.subscription.cancelled" | "team.subscription.deleted" | "team.order.deleted.internal" | "team.project.transferred.to.team" | "team.project.transferred.from.team" | "team.domain.verification.requested" | "team.domain.verification.completed" | "team.domain.unlinked" | "team.join.request.created" | "style.guide.uploaded" | "style.guide.downloaded" | "style.guide.updated" | "style.guide.deleted" | "analytics.filter.changed" | "analytics.trial.start" | "ai.profile.created" | "ai.profile.modified" | "ai.profile.deleted" | "ai.profile.evaluation.run.started" | "ai.profile.evaluation.run.completed" | "team.tool.execution.approved" | "project.added" | "project.snapshot" | "project.snapshot.restored" | "project.imported" | "project.exported" | "project.deleted" | "project.offline.imported" | "project.offline.exported" | "project.team.changed" | "project.updated" | "project.copied" | "project.viewer.user.created" | "project.export.keys.skipped" | "project.contributor.invited" | "project.import.started" | "languages.added" | "language.removed" | "language.settings.changed" | "key.added" | "keys.deleted" | "key.modified" | "keys.added" | "keys.modified" | "review.center.keys.shared" | "keys.archived" | "keys.un.archive" | "translation.updated" | "translation.proofread" | "translations.updated" | "translations.proofread" | "translations.bulk.action.undo" | "translations.verified" | "translations.unverified" | "contributor.added" | "contributor.deleted" | "public.contributor.added" | "contributor.access.modified" | "key.comment.added" | "keys.comments.added" | "task.created" | "task.closed" | "task.deleted" | "task.language.closed" | "task.item.closed" | "task.item.reopened" | "task.queued" | "task.unqueued" | "task.language.opened" | "task.locking.changed" | "task.keys.added" | "task.keys.removed" | "task.initial.tm.leverage.calculated" | "task.due.date.changed" | "language.deleted.from.task" | "project.token.created" | "project.token.deleted" | "webhook.request" | "statuses.set.for.translation" | "statuses.add.for.translation" | "statuses.remove.for.translation" | "status.created" | "status.updated" | "status.deleted" | "statuses.toggled.in.project" | "statuses.multi.toggled.in.project" | "statuses.set.for.translations" | "statuses.unset.for.translations" | "glossary.item.updated" | "glossary.item.created" | "glossary.item.deleted" | "glossary.all.items.deleted" | "glossary.items.extracted" | "glossary.csv.uploaded" | "glossary.item.extract.initiate" | "glossary.csv.downloaded" | "glossary.item.approved" | "glossary.item.rejected" | "glossary.item.status.reset" | "glossary.item.bulk.deleted" | "project.branch.added" | "project.branch.deleted" | "project.branch.merged" | "settings.automations.updated" | "html.parsing.rules.interaction" | "integration.enabled" | "git.repository.added" | "integration.disabled" | "event.workflow.added" | "event.workflow.removed" | "integration.viewed" | "event.integration.saved" | "integration.exported" | "integration.export.failed" | "integration.export.success" | "hook.error" | "hook.started" | "hook.skipped" | "download.tmx" | "file.deleted" | "ai.model.project.settings.updated" | "project.ai.profile.added" | "project.ai.profile.removed" | "project.tool.execution.approved" | "user.created" | "user.updated" | "user.deleted" | "user.password.changed" | "user.authentication.succeeded" | "user.authentication.logged.out" | "user.authentication.switched.teams" | "user.api.token.created" | "user.api.token.deleted" | "user.notification.settings.updated" | "user.two.factor.enabled" | "user.two.factor.disabled" | "onboarding.step.completed" | "onboarding.step.skipped" | "onboarding.completed" | "user.tool.execution.approved" | "team.order.created" | "team.order.completed" | "team.order.destroyed") | No | Exact provider-documented audit event code. |
| `project_id` | integer | No | Numeric audit project ID to filter by. This differs from the dotted project ID used by Lokalise API2. |
| `next_cursor` | string | No | Continuation value returned by a previous call; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Branches

**Slug:** `LOKALISE_LIST_BRANCHES`

List one page of branches for a Lokalise project. This capability requires a Software project with Branching enabled; it is unavailable for other project types or projects with Branching disabled.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum branches to return in this page (1-5000). |
| `project_id` | string | Yes | ID of a Software project with Branching enabled. Other project types, or Software projects with Branching disabled, cannot use this tool. |
| `next_cursor` | string | No | Continuation value returned by a previous call. Omit for the first page and pass it back unchanged to continue. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Keys

**Slug:** `LOKALISE_LIST_KEYS`

Search and return one cursor page of keys from a Lokalise project or branch. Translation, comment, and screenshot expansion is opt-in to keep responses small. Branch access requires a branch-enabled Software project.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tags` | array | No | Tags to filter by. A list, CSV string, or JSON-array string is accepted. |
| `limit` | integer | No | Maximum keys to return in this cursor page (1-500). |
| `key_ids` | array | No | Numeric key IDs to return. A list, CSV string, or JSON-array string is accepted. |
| `archived` | string ("exclude" | "include" | "only") | No | Whether archived keys are excluded, included, or returned exclusively. |
| `filenames` | array | No | Filenames to filter by. A list, CSV string, or JSON-array string is accepted. |
| `key_names` | array | No | Key names to match. A list, CSV string, or JSON-array string is accepted. |
| `platforms` | array | No | Platforms to filter by: android, ios, other, or web. |
| `qa_issues` | array | No | QA issue types to filter by. |
| `project_id` | string | Yes | Lokalise project ID. |
| `branch_name` | string | No | Branch name. Omit for the default project; when set, the project must be a branch-enabled Software project. |
| `next_cursor` | string | No | Opaque continuation value returned as next_cursor by the previous call. Repeat the project, branch, and filters when continuing. |
| `include_comments` | boolean | No | Include key comments in each result. |
| `untranslated_only` | boolean | No | When true, return only untranslated keys. Omit or set false for no filter. |
| `disable_references` | boolean | No | Disable key-reference expansion in returned translations. |
| `include_screenshots` | boolean | No | Include attached screenshot metadata and URLs in each result. |
| `include_translations` | boolean | No | Include translations in each key. Keep false unless needed because this materially increases response size. |
| `translation_language_ids` | array | No | Language IDs whose translations should be included. A list, CSV string, or JSON-array string is accepted. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Project Languages

**Slug:** `LOKALISE_LIST_PROJECT_LANGUAGES`

List one page of languages configured for a Lokalise project or, when branch_name is supplied, for a branch. Branch access requires a compatible Software project with Branching enabled.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum languages to return in this page (1-5000). |
| `project_id` | string | Yes | Lokalise project ID, for example 3002780358964f9bab5a92.87762498. |
| `branch_name` | string | No | Branch name. Omit for the default project; when set, the project must be a branch-enabled Software project. |
| `next_cursor` | string | No | Opaque continuation value returned by a previous call. Omit for the first page and pass it back unchanged to continue. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Projects

**Slug:** `LOKALISE_LIST_PROJECTS`

List projects available to the connected Lokalise API token, optionally filtered by team or exact project names. Include settings to discover whether a Software project has Branching enabled.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum projects to return in this page (1-5000). |
| `team_id` | integer | No | Return only projects owned by this numeric Lokalise team ID. |
| `next_cursor` | string | No | Continuation value returned by a previous call; omit for the first page. |
| `project_names` | array | No | Exact project names to filter by. |
| `include_settings` | boolean | No | Include project settings, including whether branching is enabled. Keep enabled when discovering projects for branch operations. |
| `include_statistics` | boolean | No | Include project statistics such as key and language totals. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Translations

**Slug:** `LOKALISE_LIST_TRANSLATIONS`

Search and return one cursor page of translations from a Lokalise project or branch by language, review state, task, or QA issue. Branch access requires a branch-enabled Software project.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum translations to return in this cursor page (1-5000). |
| `qa_issues` | array | No | QA issue types to filter by. A list, CSV string, or JSON-array string is accepted. |
| `project_id` | string | Yes | Lokalise project ID. |
| `branch_name` | string | No | Branch name. Omit for the default project; when set, the project must be a branch-enabled Software project. |
| `is_reviewed` | boolean | No | Filter by Reviewed state. Omit to include both states. |
| `language_id` | integer | No | Return translations for this numeric project language ID. |
| `next_cursor` | string | No | Opaque continuation value returned as next_cursor by the previous call. Repeat the project, branch, and filters when continuing. |
| `is_unverified` | boolean | No | Filter by Unverified state. Omit to include both states. |
| `active_task_id` | integer | No | Return translations belonging to this active task ID. |
| `is_untranslated` | boolean | No | Filter by untranslated state. Omit to include both states. |
| `disable_references` | boolean | No | Disable key-reference expansion in returned translation content. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Keys

**Slug:** `LOKALISE_UPDATE_KEYS`

Batch update keys and their translations, including key metadata, translation content, review flags, and custom statuses, in one Lokalise project or branch. Requires a personal read/write API token and the project's Manage keys admin right. Branch targets additionally require a branch-enabled Software project.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `keys` | array | Yes | Keys to update in this batch. Omitted fields remain unchanged. |
| `project_id` | string | Yes | Lokalise project ID containing the keys. |
| `branch_name` | string | No | Branch name. Omit for the default project; when set, the project must be a branch-enabled Software project. |
| `use_automations` | boolean | No | Run project automations on updated translations. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Translation

**Slug:** `LOKALISE_UPDATE_TRANSLATION`

Update one translation's content and review or status flags in a Lokalise project or branch. Requires a personal read/write API token; a read-only token cannot perform this action. Branch targets additionally require a compatible Software project with Branching enabled.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_id` | string | Yes | Lokalise project ID containing the translation. |
| `branch_name` | string | No | Branch name. Omit for the default project; when set, the project must be a branch-enabled Software project. |
| `is_reviewed` | boolean | No | Set whether the Reviewed flag is enabled. |
| `translation` | string | Yes | New translation text, or an object of plural forms for a plural key. |
| `is_unverified` | boolean | No | Set whether the Unverified flag is enabled. |
| `translation_id` | integer | Yes | Numeric translation ID returned by LIST_TRANSLATIONS. |
| `custom_translation_status_ids` | array | No | Custom translation status IDs to assign; supplied values replace existing statuses. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |