Project

The project is the central element of localeUI. It serves as a container for all language files, translations and settings. Each project has its own API ID, which is used to identify the project in API requests.

A project contains basic information such as the project name, the technology, the framework and format of the source files. It also links other API objects such as source files, translations and languages.

This endpoint retrieves the details of an individual project based on its unique project ID. It provides all relevant metadata about the project, including name, technology, framework and format of the source files.

Properties:

• Method: GET
• Endpoint: https://localeui.com/api/v1/projects/[Project API ID]
• Authentication: Required (bearer token)
• Path parameters:
  • Project API ID (String) - The unique API ID of the project

Example request:

      

        

        Command line
      $  curl -X GET https://localeui.com/api/v1/projects/[Project API ID] \ 
        -H "Authorization: Bearer [Your API token]" \
        -H "Content-Type: application/json"

Example response:

In response to a valid request to the interface, the requested project is returned. Shown in the following example.

      

        

        Response
        200 OK
      {
    "api_id": "pro_12345678901234567890",
    "name": "Test Project",
    "technology": "ruby",
    "framework": "rails",
    "format": "yml"
}

Response field description