Effective changes

2024-10-10

Added new endpoint that allows to get permission templates (a.k.a roles) for lokalise API and use them as role_id parameter with contributor/user-group creation process to automatically set permissions. Works with the new permission model only.

2024-07-17

Added tm_leveragefield to language object in task related endpoints. Deprecated initial_tm_leveragefield.

2024-07-05

Updated the description of quota usage fields, to better match the actual meaning of those fields

2024-05-14

List all keys and List all translations endpoint now support cursor-based pagination, in addition to the default page based method. To use cursor based pagination, change the value of the pagination parameter to cursor. Then use the following parameter:

• cursor (string) — default value is null. Specifies the cursor starting from which results will be returned.

Please note that the limit parameter is used in both paging methods, but the page parameter is only used with page-based pagination.

When using cursor-based pagination, each response contains the following headers:

• X-Pagination-Limit — entries displayed per response. This value equals to the limit value GET param sent in the request.
• X-Pagination-Next-Cursor — cursor of the next result. Use this value for the cursor parameter in your next request to receive the next batch of results.

2022-10-20

Projects and Snapshots. We are sunsetting the upvoting feature and thus the upvoting attribute from the settings object has been removed from the response body of the following endpoints:

• List all projects
• Create a project
• Retrieve a project
• Update a project
• Restore a snapshot

2022-09-25

Keys: Reduced limit for fetching keys via the List all keys API endpoint to 500 (the current limit is 5000). We're making this change to improve the performance of our system. We recommend you update the limit parameter value (max 500) in your Lokalise list all /keys API request code as soon as possible. Requests over 500 items will get the 400 error in response.

2022-07-27

Files: Added a new Delete a file endpoint

2022-03-18

Orders: Added optional is_saved_to_translation_memory (string) parameter to Create Order endpoint.

2022-02-07

Orders: Added optional branch (string) parameter to Create an order endpoint.

2022-01-27

API2: Concurrent requests locking is removed. Rate limits remain intact.

2021-11-11

Team user billing details: Added Team User Billing Details and endpoints.

2021-11-10

Segments: Added Segments and endpoints.

The project object: Added segmentation (boolean) field to settings attributes list.

Projects: Added is_segmentation_enabled (boolean) parameter to Create a project endpoint.

2021-09-08

Contributors: Added tasks (boolean) to the list of possible values for Contributors admin_rights attribute.

Team user groups: Added tasks (boolean) to the list of possible values for Team Groups admin_rights attribute.

2021-08-02

Global: We are going to introduce rate limits for API endpoints on 14 September, 2021.