Skip to main content
Lokalise logo
  • Category: project management
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 10
  • Triggers: 0
  • Slug: LOKALISE
  • Version: 20261101_00

Tools

Slug: LOKALISE_CREATE_KEYSCreate 1 to 500 keys in a Lokalise project or branch, using a personal read/write API token and the project’s Manage keys admin right; branch targets require a compatible Software project with Branching enabled. Partial or unconfirmed batches raise an error, and some keys may already have been created.

Input Parameters

array
required
Keys to create in this batch; Lokalise supports at most 500 per request.
string
required
Lokalise project ID.
string
Branch name; omit for the default project. Requires a compatible Software project with Branching enabled.
boolean
Run project automations on translations created with these keys.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LOKALISE_DELETE_KEYSPermanently 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

array
required
One or more key IDs to permanently delete. The IDs are sent as strings in Lokalise’s required DELETE JSON body.
string
required
Lokalise project ID containing the keys to delete.
string
Branch name. Omit for the default project; when set, the project must be a branch-enabled Software project.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LOKALISE_LIST_AUDIT_LOGSList 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

integer
Maximum audit events to return in this page (1-1000).
string
Latest UTC date to include, in YYYY-MM-DD format; must not precede date_from.
integer
Numeric ID of the user who initiated the event.
string
Earliest UTC date to include, in YYYY-MM-DD format.
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")
Exact provider-documented audit event code.
integer
Numeric audit project ID to filter by. This differs from the dotted project ID used by Lokalise API2.
string
Continuation value returned by a previous call; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LOKALISE_LIST_BRANCHESList 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LOKALISE_LIST_KEYSSearch 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LOKALISE_LIST_PROJECT_LANGUAGESList 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LOKALISE_LIST_PROJECTSList 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LOKALISE_LIST_TRANSLATIONSSearch 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LOKALISE_UPDATE_KEYSBatch update keys and their translations, including metadata, content, review flags, and custom statuses, in one Lokalise project or branch. Requires a personal read/write API token and Manage keys admin right; branches require a branch-enabled Software project, and an error may leave some keys already updated.

Input Parameters

array
required
Keys to update in this batch. Omitted fields remain unchanged.
string
required
Lokalise project ID containing the keys.
string
Branch name. Omit for the default project; when set, the project must be a branch-enabled Software project.
boolean
Run project automations on updated translations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LOKALISE_UPDATE_TRANSLATIONUpdate 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

string
required
Lokalise project ID containing the translation.
string
Branch name. Omit for the default project; when set, the project must be a branch-enabled Software project.
boolean
Set whether the Reviewed flag is enabled.
string
required
New translation text, or an object of plural forms for a plural key.
boolean
Set whether the Unverified flag is enabled.
integer
required
Numeric translation ID returned by LIST_TRANSLATIONS.
array
Custom translation status IDs to assign; supplied values replace existing statuses.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not