v50

latestOpenAPI 3.1.0raw.githubusercontent.com2026-07-031984301.2 MB
Project

Get Project

Retrieves a project by identifier.

For detailed information about Translation Memory advanced configuration including filters and field updates, see Translation Memory Advanced Configuration.

get/projects/{projectId}

Query parameters

fieldsstring

A comma separated list of fields to include in the response. Every value in the list should either consist of a top-level property name (excluding the items envelope for endpoints returning lists) or refer to a property of a top-level property of type object, in the following form: "toplevelpropertyname.subpropertyname". When this query parameter is omitted, default resource representations are returned (excluding fields marked as optional). The same applies to nested objects when just specifying the top-level property name, without explicitly listing sub-property names. When specifying the fields query parameter, only the specified fields are returned. The id property is always returned.

Headers

Authorizationstring required

The bearer access token provided by Auth0.

X-LC-Tenantstring required

The identifier of the account where the request is executed.

Response

idstring required

The project identifier.

shortIdstring

The short identifier of the project.

namestring
<div style="display:inline; float:right; color:#008080; margin-top:-23px; font-size:11px">default</div><div style="display: inline;">The project name.</div>
descriptionstring

The project description.

dueBystring date-time nullable

The project due date. <br> UTC Timezone <br> Allowed formats: <br> "YYYY-MM-DDThh:mmZ" <br> "YYYY-MM-DDThh:mm:ssZ" <br> "YYYY-MM-DDThh:mm:ss.sZ" <br> "YYYY-MM-DDThh:mm:ss.ssZ" <br> "YYYY-MM-DDThh:mm:ss.sssZ"

deliveredBystring date-time nullable

UTC Timezone <br> Allowed formats: <br> "YYYY-MM-DDThh:mmZ" <br> "YYYY-MM-DDThh:mm:ssZ" <br> "YYYY-MM-DDThh:mm:ss.sZ" <br> "YYYY-MM-DDThh:mm:ss.ssZ" <br> "YYYY-MM-DDThh:mm:ss.sssZ"

createdAtstring date-time nullable

The project's creation date and time. <br> UTC Timezone <br> Allowed formats: <br> "YYYY-MM-DDThh:mmZ" <br> "YYYY-MM-DDThh:mm:ssZ" <br> "YYYY-MM-DDThh:mm:ss.sZ" <br> "YYYY-MM-DDThh:mm:ss.ssZ" <br> "YYYY-MM-DDThh:mm:ss.sssZ"

status'created' | 'inProgress' | 'completed' | 'archived' nullable

The project's status.

forceOnlineboolean

This forces the project to be translated using the Trados Cloud Platform Online Editor exclusively.