LOlokalise
Projects

Create a project

Creates a new project in the specified team. Requires Admin role in the team.

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

post/projects

Request

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

Request body

namestring required

Name of the project.

team_idnumber

ID of the team to create a project in. If this parameter is omitted, the project will be created in current team of the user, whose API token is specified.

descriptionstring

Description of the project.

base_lang_isostring

Language/locale code of the project base language. Should be in a scope of <code>languages</code> list. Use <code>custom_iso</code> code in case it was defined.

project_type'localization_files' | 'paged_documents' | 'content_integration'

Project type. Note: Only <code>localization_files</code> projects support branching. Available types:\n- <code>localization_files</code> - Software projects (Web and mobile) - Supports branching, individual key management, JWT/OTA tokens\n- <code>paged_documents</code> - Documents projects (Ad hoc documents) - ⚠️ Branching not supported\n- <code>content_integration</code> - Marketing projects (Marketing and support) - ⚠️ Branching not supported

is_segmentation_enabledboolean

Enable Segmentation feature for project.

Response

OK

project_idstring

A unique project identifier.

project_typestring

Project type descriptor. Allowed values are <code>localization_files</code> or <code>paged_documents</code>.

namestring

Project name.

descriptionstring

Description of the project.

created_atstring

Date of project creation.

created_at_timestampnumber

Unix timestamp when project was created.

created_bynumber

An identifier of a user who has created the project.

created_by_emailstring

An e-mail of a user who has created the project.

team_idnumber

A unique identifier of the team, the project belongs to.

base_language_idnumber

A unique identifier of the project default language.

base_language_isostring

A language/locale code of the project default language.

Changes

No recorded changes to this operation across all 1 revision of this API.