API: Projects API

Project management API allows you to create new projects and list existing projects using REST API.

Using this endpoint requires Personal Tokens that can be generated in account settings.

Looking for a previous version of the API? Check v1.

Table of contents

• Create project

  • Sample request
  • Request fields
  • Example successful response

• List projects

  • Sample request
  • Example successful response

Create project

Sample request

curl
    --location
    --request POST 'https://api.simplelocalize.io/api/v2/projects' \
    --header 'Authorization: <PERSONAL_TOKEN>' \
    --header 'Content-Type: application/json' \
    --data-raw '{
        "name": "My new project"
    }'

Request fields

• name (required) - project name

Example successful response

{
	"msg": "OK",
	"status": 200,
	"data": {
		"name": "My new project",
		"languages": [
			{
				"key": "en",
				"name": "English",
				"isDefault": false,
				"order": 0
			}
		],
		"projectToken": "<PROJECT_TOKEN>",
		"apiKey": "<PROJECT_API_KEY>",
		"keys": 0,
		"unpublishedChanges": 0,
		"translatedPercentage": 0.0,
		"translatedKeysByLanguage": {}
	}
}

List projects

Sample request

curl
    --location
    --request GET 'https://api.simplelocalize.io/api/v2/projects' \
    --header 'Authorization: <PERSONAL_TOKEN>'

Example successful response

{
	"msg": "OK",
	"status": 200,
	"data": [
		{
			"name": "My Project Name",
			"languages": [
				{
					"key": "en",
					"name": "english",
					"isDefault": true,
					"order": 0
				}
			],
			"customers": [
                {
                    "key": "my-customer",
                    "description": "My customer description"
                }
			],
			"projectToken": "<PROJECT_TOKEN>",
			"apiKey": "<PROJECT_API_KEY>",
			"keys": 357,
			"unpublishedChanges": 5,
			"translatedPercentage": 0.74,
			"translatedKeysByLanguage": {
				"en": 264
			}
		}
	]
}