Jump to Content
REST API
Guides
Changelog
Lokalise docs
Lokalise apps
Feedback
Home
Guides
REST API
Discussions
REST API
Guides
Changelog
Lokalise docs
Lokalise apps
Feedback
Log in
Try it free
REST API
Log in
Try it free
REST API
Bundle object
All
Pages
Start typing to search…
JUMP TO
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 comments
get
List key comments
get
Create comments
post
Retrieve a comment
get
Delete a comment
del
Contributors
List all contributors
get
Create contributors
post
Retrieve a contributor
get
Update a contributor
put
Delete a contributor
del
Retrieve a contributor representing user sending a query
get
Delete all contributors
del
Get bulk deletion job status
get
Import contributors
post
Custom Translation Statuses
List all statuses
get
Create a status
post
Retrieve a status
get
Update a status
put
Delete a status
del
Retrieve available colors
get
Files
List all files
get
Upload a file
post
Download files (Async)
post
Download files
post
Delete a file
del
JWT tokens
Create a service JWT token
post
Keys
List all keys
get
Create keys
post
Multi-update
put
Delete multiple keys
del
Retrieve a key
get
Update a key
put
Delete a key
del
Glossary
List glossary terms
get
Delete glossary terms
del
Update glossary terms
put
Create glossary terms
post
Retrieve a glossary term
get
Languages
List system languages
get
List project languages
get
Create languages
post
Retrieve a language
get
Update a language
put
Delete a language
del
Orders
List all orders
get
Create an order
post
Retrieve an order
get
Permission Templates
List all permission templates for particular team
get
Payment Cards
Create a card
post
List all cards
get
Retrieve a card
get
Delete a card
del
Projects
List all projects
get
Create a project
post
Retrieve a project
get
Update a project
put
Delete a project
del
Empty a project
put
Queued Processes
List all processes
get
Retrieve a process
get
Screenshots
List all screenshots
get
Create screenshots
post
Retrieve a screenshot
get
Delete a screenshot
del
Update a screenshot
put
Segments
List all segments for key language
get
Retrieve a segment for key language
get
Update a segment
put
Snapshots
List all snapshots
get
Create a snapshot
post
Restore a snapshot
post
Delete a snapshot
del
Tasks
List all tasks
get
Create a task
post
Retrieve a task
get
Update a task
put
Delete a task
del
Retrieve task usage metrics
get
Team Groups
List all groups
get
Create a group
post
Retrieve a group
get
Update a group
put
Delete a group
del
Add projects to group
put
Remove projects from group
put
Add members to group
put
Remove members from group
put
Team User Billing Details
Retrieve team user billing details
get
Create team user billing details
post
Update team user billing details
put
Team Users
List all team users
get
Retrieve a team user
get
Update a team user
put
Delete a team user
del
Teams
List all teams
get
Get team details
get
Translation Providers
List all providers
get
Retrieve a provider
get
Translations
List all translations
get
Retrieve a translation
get
Update a translation
put
Webhooks
List all webhooks
get
Create a webhook
post
Retrieve a webhook
get
Update a webhook
put
Delete a webhook
del
Regenerate a webhook secret
patch
Users
Retrieve a basic user data
get
Projects with branches
Branches
List all branches
get
Create a branch
post
Retrieve a branch
get
Update a branch
put
Delete a branch
del
Merge a branch
post
Comments
List project comments
get
List key comments
get
Create comments
post
Retrieve a comment
get
Delete a comment
del
Files
List all files
get
Upload a file
post
Download files (Async)
post
Download files
post
Delete a file
del
Keys
List all keys
get
Create keys
post
Multi-update
put
Delete multiple keys
del
Retrieve a key
get
Update a key
put
Delete a key
del
Languages
List project languages
get
Create languages
post
Retrieve a language
get
Update a language
put
Delete a language
del
Projects
List all projects
get
Create a project
post
Retrieve a project
get
Update a project
put
Delete a project
del
Empty a project
put
Queued Processes
List all processes
get
Retrieve a process
get
Screenshots
Update a screenshot
put
Tasks
List all tasks
get
Create a task
post
Retrieve a task
get
Update a task
put
Delete a task
del
Retrieve task usage metrics
get
Translations
List all translations
get
Retrieve a translation
get
Update a translation
put
OTA
Working with the OTA API
Bundle management
List bundles
get
Get bundle
get
Update bundle
patch
Delete a bundle
del
Bundle freezes
List freeze periods
get
Create freeze period
post
Update freeze period
put
Delete freeze period
del
Statistics
View usage
get
OTA bundles
Bundle object
Get OTA bundle
get
SDK tokens
List tokens
get
Create token
post
Delete token
del
Publishing
Publish bundle
post
Stage bundle
post
Bundle object
Ask AI
