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
All
Pages
Start typing to search…

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
    • List project commentsget
    • List key commentsget
    • Create commentspost
    • Retrieve a commentget
    • Delete a commentdel
  • Contributors
    • List all contributorsget
    • Create contributorspost
    • Retrieve a contributorget
    • Update a contributorput
    • Delete a contributordel
    • Retrieve a contributor representing user sending a queryget
  • Custom Translation Statuses
    • List all statusesget
    • Create a statuspost
    • Retrieve a statusget
    • Update a statusput
    • Delete a statusdel
    • Retrieve available colorsget
  • Files
    • List all filesget
    • Upload a filepost
    • Download files (Async)post
    • Download filespost
    • Delete a filedel
  • JWT tokens
    • Create a service JWT tokenpost
  • Keys
    • List all keysget
    • Create keyspost
    • Multi-updateput
    • Delete multiple keysdel
    • Retrieve a keyget
    • Update a keyput
    • Delete a keydel
  • Glossary
    • List glossary termsget
    • Delete glossary termsdel
    • Update glossary termsput
    • Create glossary termspost
    • Retrieve a glossary termget
  • Languages
    • List system languagesget
    • List project languagesget
    • Create languagespost
    • Retrieve a languageget
    • Update a languageput
    • Delete a languagedel
  • Orders
    • List all ordersget
    • Create an orderpost
    • Retrieve an orderget
  • Permission Templates
    • List all permission templates for particular teamget
  • Payment Cards
    • Create a cardpost
    • List all cardsget
    • Retrieve a cardget
    • Delete a carddel
  • Projects
    • List all projectsget
    • Create a projectpost
    • Retrieve a projectget
    • Update a projectput
    • Delete a projectdel
    • Empty a projectput
  • Queued Processes
    • List all processesget
    • Retrieve a processget
  • Screenshots
    • List all screenshotsget
    • Create screenshotspost
    • Retrieve a screenshotget
    • Delete a screenshotdel
    • Update a screenshotput
  • Segments
    • List all segments for key languageget
    • Retrieve a segment for key languageget
    • Update a segmentput
  • Snapshots
    • List all snapshotsget
    • Create a snapshotpost
    • Restore a snapshotpost
    • Delete a snapshotdel
  • Tasks
    • List all tasksget
    • Create a taskpost
    • Retrieve a taskget
    • Update a taskput
    • Delete a taskdel
  • Team Groups
    • List all groupsget
    • Create a grouppost
    • Retrieve a groupget
    • Update a groupput
    • Delete a groupdel
    • Add projects to groupput
    • Remove projects from groupput
    • Add members to groupput
    • Remove members from groupput
  • Team User Billing Details
    • Retrieve team user billing detailsget
    • Create team user billing detailspost
    • Update team user billing detailsput
  • Team Users
    • List all team usersget
    • Retrieve a team userget
    • Update a team userput
    • Delete a team userdel
  • Teams
    • List all teamsget
    • Get team detailsget
  • Translation Providers
    • List all providersget
    • Retrieve a providerget
  • Translations
    • List all translationsget
    • Retrieve a translationget
    • Update a translationput
  • Webhooks
    • List all webhooksget
    • Create a webhookpost
    • Retrieve a webhookget
    • Update a webhookput
    • Delete a webhookdel
    • Regenerate a webhook secretpatch
  • Users
    • Retrieve a basic user dataget

Projects with branches

  • Branches
    • List all branchesget
    • Create a branchpost
    • Retrieve a branchget
    • Update a branchput
    • Delete a branchdel
    • Merge a branchpost
  • Comments
    • List project commentsget
    • List key commentsget
    • Create commentspost
    • Retrieve a commentget
    • Delete a commentdel
  • Files
    • List all filesget
    • Upload a filepost
    • Download files (Async)post
    • Download filespost
    • Delete a filedel
  • Keys
    • List all keysget
    • Create keyspost
    • Multi-updateput
    • Delete multiple keysdel
    • Retrieve a keyget
    • Update a keyput
    • Delete a keydel
  • Languages
    • List project languagesget
    • Create languagespost
    • Retrieve a languageget
    • Update a languageput
    • Delete a languagedel
  • Projects
    • List all projectsget
    • Create a projectpost
    • Retrieve a projectget
    • Update a projectput
    • Delete a projectdel
    • Empty a projectput
  • Queued Processes
    • List all processesget
    • Retrieve a processget
  • Screenshots
    • Update a screenshotput
  • Tasks
    • List all tasksget
    • Create a taskpost
    • Retrieve a taskget
    • Update a taskput
    • Delete a taskdel
  • Translations
    • 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 bundledel
  • Bundle freezes
    • List freeze periodsget
    • Create freeze periodpost
    • Update freeze periodput
    • Delete freeze perioddel
  • Statistics
    • View usageget
  • OTA bundles
    • Bundle object
    • Get OTA bundleget
  • SDK tokens
    • List tokensget
    • Create tokenpost
    • Delete tokendel
  • 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.