← Tools Reference

Lokalise

Lokalise integration (Productivity, Developer Tools). Imported from open-connector.

API key11 toolshttps://api.lokalise.com/api2
GET
lokalise_list_projects
List Lokalise projects visible to the API token.

/projects

6 parameters
ParamTypeRequiredDescription
filter_team_idintegeroptionalLimit results to this Lokalise team ID.
filter_namesstringoptionalOne or more project names to filter by, comma-separated.
include_statisticsbooleanoptionalWhether to include project statistics.
include_settingsbooleanoptionalWhether to include project settings.
limitintegeroptionalThe number of items to include, up to 5000.
pageintegeroptionalReturn results starting from this page.
GET
lokalise_get_project
Retrieve one Lokalise project by project ID.

/projects/{project_id}

1 parameter
ParamTypeRequiredDescription
project_idstringrequiredThe unique Lokalise project identifier.
GET
lokalise_list_project_languages
List languages configured on a Lokalise project.

/projects/{project_id}/languages

3 parameters
ParamTypeRequiredDescription
project_idstringrequiredThe unique Lokalise project identifier.
limitintegeroptionalThe number of items to include, up to 5000.
pageintegeroptionalReturn results starting from this page.
GET
lokalise_list_keys
List translation keys in a Lokalise project.

/projects/{project_id}/keys

16 parameters
ParamTypeRequiredDescription
project_idstringrequiredThe unique Lokalise project identifier.
disable_referencesbooleanoptionalWhether to disable key references.
include_commentsbooleanoptionalWhether to include comments.
include_screenshotsbooleanoptionalWhether to include screenshot URLs.
include_translationsbooleanoptionalWhether to include translations.
filter_translation_lang_idsstringoptionalOne or more language IDs to include translations for, comma-separated.
filter_tagsstringoptionalOne or more tags to filter by, comma-separated.
filter_filenamesstringoptionalOne or more filenames to filter by, comma-separated.
filter_keysstringoptionalOne or more key names to filter by, comma-separated.
filter_key_idsstringoptionalOne or more key identifiers to filter by, comma-separated.
filter_platformsstringoptionalOne or more platforms to filter by, comma-separated.
filter_untranslatedbooleanoptionalWhether to filter untranslated keys.
filter_qa_issuesstringoptionalOne or more QA issue codes to filter by, comma-separated.
filter_archivedstringoptionalThe archive filter to apply.
limitintegeroptionalThe number of keys to include, up to 500.
pageintegeroptionalReturn results starting from this page.
POST
lokalise_create_keys
Create one or more translation keys in a Lokalise project.

/projects/{project_id}/keys

3 parameters
ParamTypeRequiredDescription
project_idstringrequiredThe unique Lokalise project identifier.
keysarrayrequiredKeys to add to the project.
use_automationsbooleanoptionalWhether to run automations on the new key translations.
GET
lokalise_get_key
Retrieve one Lokalise key by key ID.

/projects/{project_id}/keys/{keyId}

4 parameters
ParamTypeRequiredDescription
project_idstringrequiredThe unique Lokalise project identifier.
key_idintegerrequiredThe unique Lokalise key identifier.
disable_referencesbooleanoptionalWhether to disable key references.
keyIdstringrequiredPath parameter: keyId
PUT
lokalise_update_key
Update one Lokalise key by key ID.

/projects/{project_id}/keys/{keyId}

16 parameters
ParamTypeRequiredDescription
project_idstringrequiredThe unique Lokalise project identifier.
key_idintegerrequiredThe unique Lokalise key identifier.
key_namestringoptionalThe key identifier.
descriptionstringoptionalThe key description.
platformsarrayoptionalPlatforms enabled for the key.
filenamesobjectoptionalFilenames for each platform.
tagsarrayoptionalTags to assign to the key.
merge_tagsbooleanoptionalWhether to merge supplied tags with existing tags.
is_pluralbooleanoptionalWhether this key is plural.
plural_namestringoptionalThe custom plural name.
is_hiddenbooleanoptionalWhether this key is hidden from non-admin contributors.
is_archivedbooleanoptionalWhether this key is archived.
contextstringoptionalThe optional key context.
char_limitnumberoptionalThe maximum allowed number of characters.
custom_attributesstringoptionalJSON encoded custom key attributes.
keyIdstringrequiredPath parameter: keyId
DELETE
lokalise_delete_key
Delete one Lokalise key by key ID.

/projects/{project_id}/keys/{keyId}

3 parameters
ParamTypeRequiredDescription
project_idstringrequiredThe unique Lokalise project identifier.
key_idintegerrequiredThe unique Lokalise key identifier.
keyIdstringrequiredPath parameter: keyId
GET
lokalise_list_translations
List translation items in a Lokalise project.

/projects/{project_id}/translations

10 parameters
ParamTypeRequiredDescription
project_idstringrequiredThe unique Lokalise project identifier.
disable_referencesbooleanoptionalWhether to disable key references.
filter_lang_idintegeroptionalReturn translations only for this language ID.
filter_is_reviewedbooleanoptionalWhether to filter reviewed translations.
filter_unverifiedbooleanoptionalWhether to filter unverified translations.
filter_untranslatedbooleanoptionalWhether to filter untranslated translations.
filter_qa_issuesstringoptionalOne or more QA issue codes to filter by, comma-separated.
filter_active_task_idintegeroptionalFilter translations by this active task ID.
limitintegeroptionalThe number of items to include, up to 5000.
pageintegeroptionalReturn results starting from this page.
GET
lokalise_get_translation
Retrieve one Lokalise translation by translation ID.

/projects/{project_id}/translations/{translationId}

4 parameters
ParamTypeRequiredDescription
project_idstringrequiredThe unique Lokalise project identifier.
translation_idintegerrequiredThe unique Lokalise translation identifier.
disable_referencesbooleanoptionalWhether to disable key references.
translationIdstringrequiredPath parameter: translationId
PUT
lokalise_update_translation
Update one Lokalise translation by translation ID.

/projects/{project_id}/translations/{translationId}

7 parameters
ParamTypeRequiredDescription
project_idstringrequiredThe unique Lokalise project identifier.
translation_idintegerrequiredThe unique Lokalise translation identifier.
translationstringrequiredTranslation content as text or plural-form object.
is_unverifiedbooleanoptionalWhether the translation should be marked unverified.
is_reviewedbooleanoptionalWhether the translation should be marked reviewed.
custom_translation_status_idsarrayoptionalCustom translation status IDs to assign, replacing existing statuses.
translationIdstringrequiredPath parameter: translationId