Lokalise
App · 23 actions
Manage your Lokalise localization: projects and languages, translation keys, translations and comments, contributors and tasks, and export translation files.
Actions
| Action | What it does |
|---|---|
| Add comment | Add a comment to a key, for translators and reviewers. |
| Add language to project | Add a language to a project so its keys can be translated into it. |
| Create key | Add a key to a project, optionally with its translations. |
| Create project | Create a translation project with a base language. |
| Delete comment | Delete a comment from a key. |
| Delete key | Delete a key with all its translations. |
| Delete project | Permanently delete a project with all its keys and translations. |
| Export translations | Build a zip of the project's translations (one file per language) and return its download link. |
| Get key | Get one key with its platforms, tags and translations. |
| Get project | Get one project with its settings and translation progress. |
| Get translation | Get one translation with its text and whether it is verified and reviewed. |
| List comments | List the comments on one key, or on every key in the project when no key is given. |
| List contributors | List the people working on a project, with their roles and languages. |
| List keys | List a project's keys, optionally narrowed by name, tag or platform and with their translations. |
| List project languages | List the languages a project is translated into. |
| List projects | List the projects you can see, with their languages and progress. |
| List supported languages | List every language Lokalise supports, with the codes used to add them to a project. |
| List tasks | List a project's translation tasks, optionally by status. |
| List translations | List a project's translations, optionally for one language or one status. |
| Remove language from project | Remove a language and all its translations from a project. |
| Update key | Change a key's name, platforms, description or tags. |
| Update project | Rename a project or change its description. |
| Update translation | Set a translation's text, and optionally mark it verified or reviewed. |
Add comment
Add a comment to a key, for translators and reviewers.
Inputs
- Project
project_idtextRequired - The Lokalise project. Pick one, or give its id from an earlier step.
- Key ID
key_idnumberRequired - The key's number, from 'List keys' or 'Create key'.
- Comment
commenttextRequired - The comment's text.
Outputs
commentobject- The comment
Example output
{
"comment": {
"added_at": "2026-10-15 09:00:00 (Etc/UTC)",
"added_at_timestamp": 1792054800,
"added_by": 1234,
"added_by_email": "jo@example.com",
"comment": "Keep it short.",
"comment_id": 7001,
"key_id": 635001
}
}Add language to project
Add a language to a project so its keys can be translated into it.
Inputs
- Project
project_idtextRequired - The Lokalise project. Pick one, or give its id from an earlier step.
- Language
lang_isotextRequired - The language, by code such as en, fr or pt_BR.
Outputs
languageobject- The language added
project_idtext- The project's id
Example output
{
"language": {
"is_rtl": false,
"lang_id": 640,
"lang_iso": "en",
"lang_name": "English",
"plural_forms": [
"one",
"other"
]
},
"project_id": "123456789abcdef.12345678"
}Create key
Add a key to a project, optionally with its translations. Fails if the key name is already used on the same platform.
Inputs
- Project
project_idtextRequired - The Lokalise project. Pick one, or give its id from an earlier step.
- Key name
key_nametextRequired - The key's identifier in your code, such as checkout.title.
- Platforms
platformslist - Where the key is used. Defaults to Web.One or more of:
web,ios,android,other. - Description
descriptiontext - A note for translators about where and how the text is used.
- Tags
tagstext - Tags to put on the key, separated by commas.
- Translations
translationsobject - The text in each language, for example {"en": "Checkout"}. Each language must already be in the project.
Outputs
keyobject- The key
Example output
{
"key": {
"base_words": 1,
"char_limit": 0,
"comments": [],
"context": "",
"created_at": "2026-10-15 09:00:00 (Etc/UTC)",
"description": "Heading of the checkout page",
"filenames": {
"android": "",
"ios": "",
"other": "",
"web": ""
},
"is_archived": false,
"is_hidden": false,
"is_plural": false,
"key_id": 635001,
"key_name": {
"android": "checkout.title",
"ios": "checkout.title",
"other": "checkout.title",
"web": "checkout.title"
},
"modified_at": "2026-10-15 09:00:00 (Etc/UTC)",
"platforms": [
"web"
],
"plural_name": "",
"screenshots": [],
"tags": [
"checkout"
],
"translations": [
{
"is_reviewed": false,
"is_unverified": false,
"key_id": 635001,
"language_iso": "en",
"modified_at": "2026-10-15 09:00:00 (Etc/UTC)",
"modified_by": 1234,
"modified_by_email": "jo@example.com",
"reviewed_by": 0,
"task_id": 0,
"translation": "Checkout",
"translation_id": 344412,
"words": 1
}
],
"translations_modified_at": "2026-10-15 09:00:00 (Etc/UTC)"
}
}Create project
Create a translation project with a base language.
Inputs
- Name
nametextRequired - The project's name.
- Description
descriptiontext - What the project is for.
- Base language
base_lang_isotext - The language the text is written in. Defaults to English.
Outputs
projectobject- The project
Example output
{
"project": {
"base_language_id": 640,
"base_language_iso": "en",
"created_at": "2026-10-01 09:00:00 (Etc/UTC)",
"created_at_timestamp": 1790845200,
"created_by": 1234,
"created_by_email": "jo@example.com",
"description": "Strings for the mobile app",
"name": "Mobile app",
"project_id": "123456789abcdef.12345678",
"project_type": "localization_files",
"settings": {
"per_platform_key_names": false,
"reviewing": true
},
"statistics": {
"keys_total": 2,
"progress_total": 50,
"team": 1
},
"team_id": 5678
}
}Delete comment
Delete a comment from a key.
Inputs
- Project
project_idtextRequired - The Lokalise project. Pick one, or give its id from an earlier step.
- Key ID
key_idnumberRequired - The key's number, from 'List keys' or 'Create key'.
- Comment ID
comment_idnumberRequired - The comment's number, from 'List comments' or 'Add comment'.
Outputs
comment_idnumber- The comment deleted
deletedtrue/false- Always true once deleted
key_idnumber- The key it was on
Example output
{
"comment_id": 7001,
"deleted": true,
"key_id": 635001
}Delete key
Delete a key with all its translations. This cannot be undone.
Inputs
- Project
project_idtextRequired - The Lokalise project. Pick one, or give its id from an earlier step.
- Key ID
key_idnumberRequired - The key's number, from 'List keys' or 'Create key'.
Outputs
deletedtrue/false- Always true once deleted
key_idnumber- The key deleted
project_idtext- The project's id
Example output
{
"deleted": true,
"key_id": 635001,
"project_id": "123456789abcdef.12345678"
}Delete project
Permanently delete a project with all its keys and translations. This cannot be undone.
Inputs
- Project
project_idtextRequired - The Lokalise project. Pick one, or give its id from an earlier step.
Outputs
deletedtrue/false- Always true once deleted
project_idtext- The project's id
Example output
{
"deleted": true,
"project_id": "123456789abcdef.12345678"
}Export translations
Build a zip of the project's translations (one file per language) and return its download link. The link works for a limited time.
Inputs
- Project
project_idtextRequired - The Lokalise project. Pick one, or give its id from an earlier step.
- File format
export_formattext - The file format of each language. Defaults to JSON.One of:
json,json_structured(JSON (nested keys)),xliff,po(Gettext (.po)),strings(iOS Strings),xml(Android XML),properties(Java Properties),csv,xlsx(Excel (.xlsx)),yaml,arb(Flutter ARB). - Language
lang_isotext - Only this language, by code such as en, fr or pt_BR. Leave empty for all.
Outputs
bundle_urltext- Where to download the zip
formattext- The file format exported
project_idtext- The project's id
Example output
{
"bundle_url": "https://s3-eu-west-1.amazonaws.com/lokalise-assets/export.zip",
"format": "json",
"project_id": "123456789abcdef.12345678"
}Get key
Get one key with its platforms, tags and translations.
Inputs
- Project
project_idtextRequired - The Lokalise project. Pick one, or give its id from an earlier step.
- Key ID
key_idnumberRequired - The key's number, from 'List keys' or 'Create key'.
Outputs
keyobject- The key
Example output
{
"key": {
"base_words": 1,
"char_limit": 0,
"comments": [],
"context": "",
"created_at": "2026-10-15 09:00:00 (Etc/UTC)",
"description": "Heading of the checkout page",
"filenames": {
"android": "",
"ios": "",
"other": "",
"web": ""
},
"is_archived": false,
"is_hidden": false,
"is_plural": false,
"key_id": 635001,
"key_name": {
"android": "checkout.title",
"ios": "checkout.title",
"other": "checkout.title",
"web": "checkout.title"
},
"modified_at": "2026-10-15 09:00:00 (Etc/UTC)",
"platforms": [
"web"
],
"plural_name": "",
"screenshots": [],
"tags": [
"checkout"
],
"translations": [
{
"is_reviewed": false,
"is_unverified": false,
"key_id": 635001,
"language_iso": "en",
"modified_at": "2026-10-15 09:00:00 (Etc/UTC)",
"modified_by": 1234,
"modified_by_email": "jo@example.com",
"reviewed_by": 0,
"task_id": 0,
"translation": "Checkout",
"translation_id": 344412,
"words": 1
}
],
"translations_modified_at": "2026-10-15 09:00:00 (Etc/UTC)"
}
}Get project
Get one project with its settings and translation progress.
Inputs
- Project
project_idtextRequired - The Lokalise project. Pick one, or give its id from an earlier step.
Outputs
projectobject- The project
Example output
{
"project": {
"base_language_id": 640,
"base_language_iso": "en",
"created_at": "2026-10-01 09:00:00 (Etc/UTC)",
"created_at_timestamp": 1790845200,
"created_by": 1234,
"created_by_email": "jo@example.com",
"description": "Strings for the mobile app",
"name": "Mobile app",
"project_id": "123456789abcdef.12345678",
"project_type": "localization_files",
"settings": {
"per_platform_key_names": false,
"reviewing": true
},
"statistics": {
"keys_total": 2,
"progress_total": 50,
"team": 1
},
"team_id": 5678
}
}Get translation
Get one translation with its text and whether it is verified and reviewed.
Inputs
- Project
project_idtextRequired - The Lokalise project. Pick one, or give its id from an earlier step.
- Translation ID
translation_idnumberRequired - The translation's number, from 'List translations' or 'Get key'.
Outputs
translationobject- The translation
Example output
{
"translation": {
"is_reviewed": false,
"is_unverified": false,
"key_id": 635001,
"language_iso": "en",
"modified_at": "2026-10-15 09:00:00 (Etc/UTC)",
"modified_by": 1234,
"modified_by_email": "jo@example.com",
"reviewed_by": 0,
"task_id": 0,
"translation": "Checkout",
"translation_id": 344412,
"words": 1
}
}List comments
List the comments on one key, or on every key in the project when no key is given.
Inputs
- Project
project_idtextRequired - The Lokalise project. Pick one, or give its id from an earlier step.
- Key ID
key_idnumber - Only this key's comments. Leave empty for the whole project.
- Page size
limitnumber - How many to return, 1 to 500. Lokalise's default is 100.From 1 to 500.
- Page
pagenumber - Which page to return, starting at 1.At least 1.
Outputs
commentslist- The comments
countnumber- How many are on this page
pagenumber- This page's number
page_countnumber- How many pages there are
total_countnumber- How many there are in all
Example output
{
"comments": [
{
"added_at": "2026-10-15 09:00:00 (Etc/UTC)",
"added_at_timestamp": 1792054800,
"added_by": 1234,
"added_by_email": "jo@example.com",
"comment": "Keep it short.",
"comment_id": 7001,
"key_id": 635001
}
],
"count": 1,
"page": 1,
"page_count": 1,
"total_count": 1
}List contributors
List the people working on a project, with their roles and languages.
Inputs
- Project
project_idtextRequired - The Lokalise project. Pick one, or give its id from an earlier step.
- Page size
limitnumber - How many to return, 1 to 500. Lokalise's default is 100.From 1 to 500.
- Page
pagenumber - Which page to return, starting at 1.At least 1.
Outputs
contributorslist- The contributors
countnumber- How many are on this page
pagenumber- This page's number
page_countnumber- How many pages there are
total_countnumber- How many there are in all
Example output
{
"contributors": [
{
"admin_rights": [
"upload",
"download",
"settings"
],
"created_at": "2026-10-01 09:00:00 (Etc/UTC)",
"email": "jo@example.com",
"fullname": "Jo Bloggs",
"is_admin": true,
"is_reviewer": true,
"languages": [
{
"is_writable": true,
"lang_id": 640,
"lang_iso": "en",
"lang_name": "English"
}
],
"user_id": 1234
}
],
"count": 1,
"page": 1,
"page_count": 1,
"total_count": 1
}List keys
List a project's keys, optionally narrowed by name, tag or platform and with their translations. Returns one page.
Inputs
- Project
project_idtextRequired - The Lokalise project. Pick one, or give its id from an earlier step.
- Key names
filter_keystext - Only keys with these exact names, separated by commas.
- Tags
filter_tagstext - Only keys with these tags, separated by commas.
- Platform
filter_platformstext - Only keys used on this platform.One of:
web,ios,android,other. - Include translations
include_translationstrue/false - Turn on to return each key's translations too.
- Page size
limitnumber - How many to return, 1 to 500. Lokalise's default is 100.From 1 to 500.
- Page
pagenumber - Which page to return, starting at 1.At least 1.
Outputs
countnumber- How many are on this page
keyslist- The keys
pagenumber- This page's number
page_countnumber- How many pages there are
total_countnumber- How many there are in all
Example output
{
"count": 1,
"keys": [
{
"base_words": 1,
"char_limit": 0,
"comments": [],
"context": "",
"created_at": "2026-10-15 09:00:00 (Etc/UTC)",
"description": "Heading of the checkout page",
"filenames": {
"android": "",
"ios": "",
"other": "",
"web": ""
},
"is_archived": false,
"is_hidden": false,
"is_plural": false,
"key_id": 635001,
"key_name": {
"android": "checkout.title",
"ios": "checkout.title",
"other": "checkout.title",
"web": "checkout.title"
},
"modified_at": "2026-10-15 09:00:00 (Etc/UTC)",
"platforms": [
"web"
],
"plural_name": "",
"screenshots": [],
"tags": [
"checkout"
],
"translations": [
{
"is_reviewed": false,
"is_unverified": false,
"key_id": 635001,
"language_iso": "en",
"modified_at": "2026-10-15 09:00:00 (Etc/UTC)",
"modified_by": 1234,
"modified_by_email": "jo@example.com",
"reviewed_by": 0,
"task_id": 0,
"translation": "Checkout",
"translation_id": 344412,
"words": 1
}
],
"translations_modified_at": "2026-10-15 09:00:00 (Etc/UTC)"
}
],
"page": 1,
"page_count": 1,
"total_count": 1
}List project languages
List the languages a project is translated into.
Inputs
- Project
project_idtextRequired - The Lokalise project. Pick one, or give its id from an earlier step.
- Page size
limitnumber - How many to return, 1 to 500. Lokalise's default is 100.From 1 to 500.
- Page
pagenumber - Which page to return, starting at 1.At least 1.
Outputs
countnumber- How many are on this page
languageslist- The project's languages
pagenumber- This page's number
page_countnumber- How many pages there are
total_countnumber- How many there are in all
Example output
{
"count": 1,
"languages": [
{
"is_rtl": false,
"lang_id": 640,
"lang_iso": "en",
"lang_name": "English",
"plural_forms": [
"one",
"other"
]
}
],
"page": 1,
"page_count": 1,
"total_count": 1
}List projects
List the projects you can see, with their languages and progress. Gets one page; to see more, run it again with the next page it gives.
Inputs
- Project names
filter_namestext - Only projects with these exact names, separated by commas.
- Page size
limitnumber - How many to return, 1 to 500. Lokalise's default is 100.From 1 to 500.
- Page
pagenumber - Which page to return, starting at 1.At least 1.
Outputs
countnumber- How many are on this page
pagenumber- This page's number
page_countnumber- How many pages there are
projectslist- The projects
total_countnumber- How many there are in all
Example output
{
"count": 1,
"page": 1,
"page_count": 1,
"projects": [
{
"base_language_id": 640,
"base_language_iso": "en",
"created_at": "2026-10-01 09:00:00 (Etc/UTC)",
"created_at_timestamp": 1790845200,
"created_by": 1234,
"created_by_email": "jo@example.com",
"description": "Strings for the mobile app",
"name": "Mobile app",
"project_id": "123456789abcdef.12345678",
"project_type": "localization_files",
"settings": {
"per_platform_key_names": false,
"reviewing": true
},
"statistics": {
"keys_total": 2,
"progress_total": 50,
"team": 1
},
"team_id": 5678
}
],
"total_count": 1
}List supported languages
List every language Lokalise supports, with the codes used to add them to a project.
Inputs
- Page size
limitnumber - How many to return, 1 to 500. Lokalise's default is 100.From 1 to 500.
- Page
pagenumber - Which page to return, starting at 1.At least 1.
Outputs
countnumber- How many are on this page
languageslist- The languages
pagenumber- This page's number
page_countnumber- How many pages there are
total_countnumber- How many there are in all
Example output
{
"count": 1,
"languages": [
{
"is_rtl": false,
"lang_id": 640,
"lang_iso": "en",
"lang_name": "English",
"plural_forms": [
"one",
"other"
]
}
],
"page": 1,
"page_count": 1,
"total_count": 1
}List tasks
List a project's translation tasks, optionally by status.
Inputs
- Project
project_idtextRequired - The Lokalise project. Pick one, or give its id from an earlier step.
- Status
statustext - Only tasks with this status. Defaults to all.One of:
all(All (default)),created,queued,in_progress(In progress),completed. - Page size
limitnumber - How many to return, 1 to 500. Lokalise's default is 100.From 1 to 500.
- Page
pagenumber - Which page to return, starting at 1.At least 1.
Outputs
countnumber- How many are on this page
pagenumber- This page's number
page_countnumber- How many pages there are
taskslist- The tasks
total_countnumber- How many there are in all
Example output
{
"count": 1,
"page": 1,
"page_count": 1,
"tasks": [
{
"completed_at": "",
"created_at": "2026-10-10 09:00:00 (Etc/UTC)",
"description": "",
"due_date": "2026-11-01 00:00:00 (Etc/UTC)",
"languages": [
{
"language_iso": "fr",
"users": []
}
],
"progress": 25,
"status": "in_progress",
"task_id": 5001,
"task_type": "translation",
"title": "Translate to French"
}
],
"total_count": 1
}List translations
List a project's translations, optionally for one language or one status. Returns one page.
Inputs
- Project
project_idtextRequired - The Lokalise project. Pick one, or give its id from an earlier step.
- Language
lang_isotext - Only this language, by code such as en, fr or pt_BR. Leave empty for all.
- Status
statustext - Only translations with this status. Defaults to all.One of:
all(All (default)),untranslated,unverified,reviewed,not_reviewed(Not reviewed). - Page size
limitnumber - How many to return, 1 to 500. Lokalise's default is 100.From 1 to 500.
- Page
pagenumber - Which page to return, starting at 1.At least 1.
Outputs
countnumber- How many are on this page
pagenumber- This page's number
page_countnumber- How many pages there are
total_countnumber- How many there are in all
translationslist- The translations
Example output
{
"count": 1,
"page": 1,
"page_count": 1,
"total_count": 1,
"translations": [
{
"is_reviewed": false,
"is_unverified": false,
"key_id": 635001,
"language_iso": "en",
"modified_at": "2026-10-15 09:00:00 (Etc/UTC)",
"modified_by": 1234,
"modified_by_email": "jo@example.com",
"reviewed_by": 0,
"task_id": 0,
"translation": "Checkout",
"translation_id": 344412,
"words": 1
}
]
}Remove language from project
Remove a language and all its translations from a project. The base language cannot be removed.
Inputs
- Project
project_idtextRequired - The Lokalise project. Pick one, or give its id from an earlier step.
- Language
lang_isotextRequired - The language, by code such as en, fr or pt_BR.
Outputs
deletedtrue/false- Always true once deleted
lang_isotext- The language removed
project_idtext- The project's id
Example output
{
"deleted": true,
"lang_iso": "fr",
"project_id": "123456789abcdef.12345678"
}Update key
Change a key's name, platforms, description or tags. Only the fields given change.
Inputs
- Project
project_idtextRequired - The Lokalise project. Pick one, or give its id from an earlier step.
- Key ID
key_idnumberRequired - The key's number, from 'List keys' or 'Create key'.
- Key name
key_nametext - A new name for the key. Leave empty to keep it.
- Platforms
platformslist - Replace where the key is used. Leave empty to keep it.One or more of:
web,ios,android,other. - Description
descriptiontext - A new description. Leave empty to keep it.
- Tags
tagstext - Replace the key's tags, separated by commas. Leave empty to keep them.
Outputs
keyobject- The key
Example output
{
"key": {
"base_words": 1,
"char_limit": 0,
"comments": [],
"context": "",
"created_at": "2026-10-15 09:00:00 (Etc/UTC)",
"description": "Heading of the payment page",
"filenames": {
"android": "",
"ios": "",
"other": "",
"web": ""
},
"is_archived": false,
"is_hidden": false,
"is_plural": false,
"key_id": 635001,
"key_name": {
"android": "checkout.title",
"ios": "checkout.title",
"other": "checkout.title",
"web": "checkout.title"
},
"modified_at": "2026-10-15 09:00:00 (Etc/UTC)",
"platforms": [
"web"
],
"plural_name": "",
"screenshots": [],
"tags": [
"checkout"
],
"translations": [
{
"is_reviewed": false,
"is_unverified": false,
"key_id": 635001,
"language_iso": "en",
"modified_at": "2026-10-15 09:00:00 (Etc/UTC)",
"modified_by": 1234,
"modified_by_email": "jo@example.com",
"reviewed_by": 0,
"task_id": 0,
"translation": "Checkout",
"translation_id": 344412,
"words": 1
}
],
"translations_modified_at": "2026-10-15 09:00:00 (Etc/UTC)"
}
}Update project
Rename a project or change its description. Only the fields given change.
Inputs
- Project
project_idtextRequired - The Lokalise project. Pick one, or give its id from an earlier step.
- Name
nametext - A new name. Leave empty to keep it.
- Description
descriptiontext - A new description. Leave empty to keep it.
Outputs
projectobject- The project
Example output
{
"project": {
"base_language_id": 640,
"base_language_iso": "en",
"created_at": "2026-10-01 09:00:00 (Etc/UTC)",
"created_at_timestamp": 1790845200,
"created_by": 1234,
"created_by_email": "jo@example.com",
"description": "Strings for the mobile app",
"name": "Mobile app v2",
"project_id": "123456789abcdef.12345678",
"project_type": "localization_files",
"settings": {
"per_platform_key_names": false,
"reviewing": true
},
"statistics": {
"keys_total": 2,
"progress_total": 50,
"team": 1
},
"team_id": 5678
}
}Update translation
Set a translation's text, and optionally mark it verified or reviewed. Leave the two selects empty to keep its state.
Inputs
- Project
project_idtextRequired - The Lokalise project. Pick one, or give its id from an earlier step.
- Translation ID
translation_idnumberRequired - The translation's number, from 'List translations' or 'Get key'.
- Translation
translationtextRequired - The new text.
- Verified
verificationtext - Mark the translation verified or unverified. Leave empty to keep it.One of:
verified,unverified. - Reviewed
reviewtext - Mark the translation reviewed or not. Leave empty to keep it.One of:
reviewed,not_reviewed(Not reviewed).
Outputs
translationobject- The translation
Example output
{
"translation": {
"is_reviewed": false,
"is_unverified": false,
"key_id": 635001,
"language_iso": "en",
"modified_at": "2026-10-15 09:00:00 (Etc/UTC)",
"modified_by": 1234,
"modified_by_email": "jo@example.com",
"reviewed_by": 0,
"task_id": 0,
"translation": "Pay",
"translation_id": 344412,
"words": 1
}
}