v1

latestOpenAPI 3.0.3LILT Platform Terms and Conditions2026-07-26651658.7 KB

Projects

Retrieve a Project

Retrieves one or more projects, including the documents associated with each project. Retrieving a project is the most efficient way to retrieve a single project, multiple projects or a list of all available projects.

To retrieve a specific project, specify the id request parameter or you can retrieve multiple projects by adding comma (,) between ids eg. ?id=1234,5678. To retrieve all projects, omit the id request parameter. To limit the retrieved projects to those with a particular source language or target language, specify the corresponding ISO 639-1 language codes in the srclang and trglang request parameters, respectively.

get/v2/projects

Query parameters

idinteger

A unique Project identifier. It can be a single id or multiple ids separated by a comma

srclangstring

An ISO 639-1 language code.

trglangstring

An ISO 639-1 language code.

from_timeinteger

Unix time stamp (epoch, in seconds) of Projects with created_at greater than or equal to the value.

to_timeinteger

Unix time stamp (epoch, in seconds) of Projects with created_at less than the value.

statestring

A project state (backlog, inProgress, inReview, inQA, done).

archivedboolean

A flag that toggles whether to include archived projects in the response (the default is true).

connector_idinteger

A unique Connector identifier.

Response

A list of Project objects.

idinteger

A unique number identifying the Project.

memory_idinteger

A unique number identifying the associated Memory.

job_idinteger

A unique number identifying the associated Job.

srclangstring

An ISO 639-1 language identifier.

trglangstring

An ISO 639-1 language identifier.

srclocalestring

A locale identifier, supported for srclang.

trglocalestring

A locale identifier, supported for trglang.

namestring

A name for the project.

statestring

The project's state. The possible states are backlog, inProgress, inReview, inQA, and done.

due_dateinteger

The due date. Measured in seconds since the Unix epoch.

archivedboolean

The archived state of the Project.

metadataobject

A JSON object of key/value string pairs. Stores custom project information.

sample_review_percentageinteger

The project's sample review percentage.

created_atinteger

Time at which the object was created. Measured in seconds since the Unix epoch.

updated_atinteger

Time at which the object was created. Measured in seconds since the Unix epoch.

workflowStatus'READY_TO_START' | 'IN_PROGRESS' | 'DONE'

The status of the Workflow for the current project. This may not be present for all project endpoints even with workflows enabled.

Example response

[
  {
    "id": 448,
    "memory_id": 1234,
    "job_id": 1234,
    "srclang": "en",
    "trglang": "fr",
    "srclocale": "US",
    "trglocale": "FR",
    "name": "My New Project",
    "state": "backlog",
    "due_date": 1489147692,
    "metadata": {
      "connectorType": "github",
      "notes": "example metadata"
    },
    "sample_review_percentage": 20,
    "created_at": 1489147692,
    "updated_at": 1489147692,
    "workflowStatus": "READY_TO_START",
    "document": [
      {
        "id": 46530,
        "project_id": 287,
        "srclang": "en",
        "trglang": "de",
        "name": "Introduction.xliff",
        "import_error_message": "Could not parse XML.",
        "export_error_message": "Could not parse XML.",
        "status": {
          "pretranslation": "idle"
        },
        "translator_email": "translator@example.com",
        "reviewer_email": "reviewer@example.com",
        "customer_reviewer_email": "reviewer@example.com",
        "created_at": 1489147692,
        "updated_at": 1489147692,
        "is_review_complete": true
      }
    ]
  }
]