Jump to Content
Lokalise Developer HubREST APIGuidesChangelogLokalise docsLokalise appsFeedback
HomeGuidesREST APIDiscussions
REST APIGuidesChangelogLokalise docsLokalise appsFeedbackLog inTry it freeLokalise Developer Hub
REST API
Log inTry it free

Introduction

  • Lokalise REST API - Localization & translation management API
  • Client libraries
  • Authentication
  • Pagination
  • Branching
  • Plurals and placeholders
  • File formats
  • API Limitations
    • Rate limits
    • File Download limitations
  • Errors

Default projects

  • Comments
    • Comment object
    • List project commentsget
    • List key commentsget
    • Create commentspost
    • Retrieve a commentget
    • Delete a commentdelete
  • Contributors
    • Contributor object
    • List all contributorsget
    • Create contributorspost
    • Retrieve a contributorget
    • Update a contributorput
    • Delete a contributordelete
    • Retrieve a contributor representing user sending a queryget
  • Custom Translation Statuses
    • Custom translation status object
    • List all statusesget
    • Create a statuspost
    • Retrieve a statusget
    • Update a statusput
    • Delete a statusdelete
    • Retrieve available colorsget
  • Files
    • File object
    • List all filesget
    • Upload a filepost
    • Download files (Async)post
    • Download filespost
    • Delete a filedelete
  • JWT tokens
    • Create a service JWT tokenpost
  • Keys
    • Key object
    • List all keysget
    • Create keyspost
    • Multi-updateput
    • Delete multiple keysdelete
    • Retrieve a keyget
    • Update a keyput
    • Delete a keydelete
  • Glossary
    • List glossary termsget
    • Delete glossary termsdelete
    • Update glossary termsput
    • Create glossary termspost
    • Retrieve a glossary termget
  • Languages
    • Language object
    • List system languagesget
    • List project languagesget
    • Create languagespost
    • Retrieve a languageget
    • Update a languageput
    • Delete a languagedelete
  • Orders
    • Order object
    • List all ordersget
    • Create an orderpost
    • Retrieve an orderget
  • Permission Templates
    • Permission template object
    • Permissions description
    • List all permission templates for particular teamget
  • Payment Cards
    • Payment card object
    • Create a cardpost
    • List all cardsget
    • Retrieve a cardget
    • Delete a carddelete
  • Projects
    • Project object
    • List all projectsget
    • Create a projectpost
    • Retrieve a projectget
    • Update a projectput
    • Delete a projectdelete
    • Empty a projectput
  • Queued Processes
    • Queued process object
    • List all processesget
    • Retrieve a processget
  • Screenshots
    • Screenshot object
    • List all screenshotsget
    • Create screenshotspost
    • Retrieve a screenshotget
    • Delete a screenshotdelete
    • Update a screenshotput
  • Segments
    • Segments object
    • List all segments for key languageget
    • Retrieve a segment for key languageget
    • Update a segmentput
  • Snapshots
    • Snapshots object
    • List all snapshotsget
    • Create a snapshotpost
    • Restore a snapshotpost
    • Delete a snapshotdelete
  • Tasks
    • Tasks object
    • List all tasksget
    • Create a taskpost
    • Retrieve a taskget
    • Update a taskput
    • Delete a taskdelete
  • Team Groups
    • TeamUserGroups object
    • List all groupsget
    • Create a grouppost
    • Retrieve a groupget
    • Update a groupput
    • Delete a groupdelete
    • Add projects to groupput
    • Remove projects from groupput
    • Add members to groupput
    • Remove members from groupput
  • Team User Billing Details
    • TeamUserBillingDetails object
    • Retrieve team user billing detailsget
    • Create team user billing detailspost
    • Update team user billing detailsput
  • Team Users
    • TeamUsers object
    • List all team usersget
    • Retrieve a team userget
    • Update a team userput
    • Delete a team userdelete
  • Teams
    • Teams object
    • List all teamsget
    • Get team detailsget
  • Translation Providers
    • TranslationProviders object
    • List all providersget
    • Retrieve a providerget
  • Translations
    • Translations object
    • List all translationsget
    • Retrieve a translationget
    • Update a translationput
  • Webhooks
    • Webhooks object
    • List all webhooksget
    • Create a webhookpost
    • Retrieve a webhookget
    • Update a webhookput
    • Delete a webhookdelete
    • Regenerate a webhook secretpatch

Projects with branches

  • Branches
    • List all branchesget
    • Create a branchpost
    • Retrieve a branchget
    • Update a branchput
    • Delete a branchdelete
    • Merge a branchpost
  • Comments
    • Comment object
    • List project commentsget
    • List key commentsget
    • Create commentspost
    • Retrieve a commentget
    • Delete a commentdelete
  • Files
    • File object
    • List all filesget
    • Upload a filepost
    • Download files (Async)post
    • Download filespost
    • Delete a filedelete
  • Keys
    • Key object
    • List all keysget
    • Create keyspost
    • Multi-updateput
    • Delete multiple keysdelete
    • Retrieve a keyget
    • Update a keyput
    • Delete a keydelete
  • Languages
    • Language object
    • List project languagesget
    • Create languagespost
    • Retrieve a languageget
    • Update a languageput
    • Delete a languagedelete
  • Projects
    • Project object
    • List all projectsget
    • Create a projectpost
    • Retrieve a projectget
    • Update a projectput
    • Delete a projectdelete
    • Empty a projectput
  • Queued Processes
    • Queued process object
    • List all processesget
    • Retrieve a processget
  • Screenshots
    • Screenshot object
    • Update a screenshotput
  • Tasks
    • Tasks object
    • List all tasksget
    • Create a taskpost
    • Retrieve a taskget
    • Update a taskput
    • Delete a taskdelete
  • Translations
    • Translations object
    • List all translationsget
    • Retrieve a translationget
    • Update a translationput

OTA

  • Working with the OTA API
  • Bundle management
    • List bundlesget
    • Get bundleget
    • Update bundlepatch
    • Delete a bundledelete
  • Bundle freezes
    • List freeze periodsget
    • Create freeze periodpost
    • Update freeze periodput
    • Delete freeze perioddelete
  • Statistics
    • View usageget
  • OTA bundles
    • Bundle object
    • Get OTA bundleget
  • SDK tokens
    • List tokensget
    • Create tokenpost
    • Delete tokendelete
  • Publishing
    • Publish bundlepost
    • Stage bundlepost

Client libraries

Currenly we provide the following official API SDK:

  • PHP client
  • Ruby client
  • Node client
  • Golang client
  • Python client
  • Elixir client
  • Command line interface

NEW! 🚀 Localize your Flutter apps in fewer steps with instant translation updates.

Case studies
Footer case study

Behind the scenes of localization with one of Europe’s leading digital health providers

Read more

  • Product
    • For developers
    • For managers
    • For translators
    • For designers
    • Integrations
    • Security
    • Pricing
    • Automations
  • Support
    • Contact
    • Documentation
    • Status
    • Product updates
    • CLI tool
    • API reference
    • iOS SDK
    • Android SDK
    • Supported file formats
  • Company
    • About
    • Blog
    • Careers 🚀
    • Library
    • Partners
    • Case studies
    • Media kit
  • Legal
    • Terms of service
    • Privacy policy
    • Cookie policy
    • Cookies settings
    • Privacy shield
    • DPA
    • List of sub-processors
    • Candidates privacy notice
    • Lokalise Apps Terms Of Service
Follow
lokalise
Localization workflow for your web and mobile apps, games and digital content.
©2017-2023
All rights reserved.