LOlokalise
Projects

List all projects

Changed on

Retrieves a list of projects available to the user, authorized with a token. This endpoint supports cursor pagination for better performance with large datasets. When using cursor pagination, the response will include a <code>nextCursor</code> value in the response headers when more data is available. Continue making requests with the <code>nextCursor</code> value until no <code>nextCursor</code> is returned, indicating all data has been retrieved. Note that cursor pagination returns projects in creation order rather than by name: oldest first by default, or newest first with <code>sort=-created_at</code>.

Requires <code>read_projects</code> OAuth access scope.

get/projects

Request

  • Base URL
    https://api.lokalise.com/api2
  • URL
    https://api.lokalise.com/api2/projects
  • Auth
    API key in header X-Api-Token

Query parameters

filter_team_idnumber

Limit results to team ID.

filter_namesstring

One or more project names to filter by (comma separated).

include_statisticsnumber

Whether to include project statistics. Possible values are <code>1</code> and <code>0</code>.

include_settingsnumber

Whether to include project settings. Possible values are <code>1</code> and <code>0</code>.

pagination'offset' | 'cursor'

Type of pagination. Possible values are <code>offset</code> and <code>cursor</code>. The default value is <code>offset</code>. Cursor pagination is performance-optimized and does not count total records or calculate remaining pages. When using cursor pagination, continue making requests until no <code>nextCursor</code> is returned in the response headers.

limitinteger

Number of items to include (max 5000).

pageinteger

Return results starting from this page.

cursorstring

Return results starting from this cursor. When using cursor pagination, this parameter should contain the <code>nextCursor</code> value from the previous response. Continue pagination until no <code>nextCursor</code> is returned in the response headers.

sort'created_at' | '-created_at'

Sort of cursor pagination: <code>created_at</code> lists projects oldest first (default), <code>-created_at</code> newest first. Later pages inherit the direction from the cursor, so it only needs to be sent with the first request; a different value is rejected. Validated but has no effect with offset pagination.

Response

OK

Changes

  • aed61e5ea90cRevision changes
    • info

      added the new optional query request parameter cursor

    • info

      added the new optional query request parameter pagination

    • info

      added the new optional query request parameter sort

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status