Get User Projects

GET

/api/data/projects

const url = 'https://example.com/api/data/projects';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/api/data/projects

Returns all projects where the current user has access, including each file and its associated target language metadata.

Responses

200

Successful Response

application/json

Response Get User Projects Api Data Projects Get

Array<object>

UserProjectSummary

object

project_id

required

Project Id

Primary external time-ordered UUIDv7 identifier

string

name

required

Name

Display name of the project

string

continuous

required

Continuous

Whether this is a continuous project

boolean

edit_time

Any of:

number
null

number

edit_user

Any of:

string
null

string

status

Any of:

ProjectState
null

ProjectState

string

Allowed values: pending processing active complete cancelled

state

Any of:

ProjectState
null

ProjectState

string

Allowed values: pending processing active complete cancelled

deadline

Any of:

number
null

number

user_role

Any of:

string
null

string

files

required

Files

Files associated with this project

Array<object>

ProjectFileInfo

object

file_uuid

Any of:

string
null

string

file_name

required

File Name

Original filename

string

source_lang

Any of:

string
null

string

word_count

Any of:

integer
null

integer

char_count

Any of:

integer
null

integer

targets

required

Targets

Targets configured for this file

Array<object>

ProjectTargetInfo

object

target_lang

Any of:

string
null

string

target_uuid

Any of:

string
null

string

deadline

Any of:

number
null

number

row_count

required

Row Count

Number of TargetRow entries for this target

integer

last_edit_time

Any of:

number
null

number

user_role

Any of:

string
null

string

Example

[
  {
    "continuous": false,
    "deadline": 1736208000,
    "edit_time": 1735689600,
    "edit_user": "pm@example.com",
    "files": [
      {
        "file_name": "brochure.docx",
        "file_uuid": "0195f5c8-5c2a-7b58-b3f5-9d5c8e4f1a24",
        "source_lang": "eng",
        "targets": [
          {
            "deadline": 1736110000,
            "last_edit_time": 1735800000,
            "row_count": 120,
            "target_lang": "fra",
            "target_uuid": "0195f5c8-5c2a-7b58-b3f5-9d5c8e4f1a25",
            "user_role": "project_manager"
          }
        ]
      }
    ],
    "name": "Marketing Brochure",
    "project_id": "0195f5c8-5c2a-7b58-b3f5-9d5c8e4f1a23",
    "state": "active",
    "status": "active",
    "user_role": "project_manager"
  }
]