API Developers Guide

Project > Get Projects List

Fetch all user projects.

GET: /account/projects
Request Params
ParametersDescription

limit

(Optional) Limit the amount of projects returned. Default is set to 100 if no limit is provided.

page

(Optional) Each page will list the amount of projects specified by the limit parameter. Default is 0 which will return the first set of projects.

sortBy

(Optional) id | type | due | expertise
Default is set to "id".

sortDirection

(Optional)
asc - Ascending direction.
desc - Descending direction.
Default is set to descending direction.

filterByStatus

(Optional) CANCELLED | IN_PROGRESS | COMPLETED
If no value was provided will return all projects.

filterByDateFrom

(Optional) Time stamp, call will return all projects that were created after this date.

filterByDateTo

(Optional) Time stamp, call will return all projects created before this date.

filterByTag

(Optional) Filter by tag. Provide a tag name in this parameter to get only the projects with the provided tag.
Response Params
ParametersDescription

projectsCount

Number of found projects.

projects

Array of projects:

Parameter Description
id Project ID.
id_prefix Project ID prefix, added to each project.
name Project name.
type Project type (translation | transcription | proofreading | combo_translation_proofreading)
languagePair
  • source_language - Source language name and code.
  • target_language - Target language name and code.
created Time stamp of project creation date.
volume
  • unit - word | page
  • count - Number of words/pages.
estimation Estimated translation time.
expiration Once the projects is being translated this field will return a time stamp of project deadline.
expertise
  • name - Expertise name.
  • code - Expertise code.
status_summary Current project status.
child_project In case of translation + editing project, this field will return editing project id
tags Array of project tags.
custom_fields Array of custom fields.

Request Example

curl --request GET "https://www.onehourtranslation.com/api/2/account/projects?secret_key=<SECRET_KEY>&public_key=<PUBLIC_KEY>&limit=25&page=1"

Response Example

{
  "status":
  {
    "code":0,
    "msg":"ok"
  },
  "results":
  {
    "projectsCount": 167,
    "projects": [
     {
      "id": "287",
      "id_prefix": "SV",
      "name": "Example project",
      "type": "translation",
      "languagePair": {
       "source_language": {
        "name": "English",
        "code": "english"
       },
       "target_language": {
        "name": "Italian",
        "code": "italian"
       }
      },
      "created": 1487515894,
      "volume": {
        "unit": "word",
        "count": "457"
      },
      "estimation": 86400,
      "expiration": false,
      "expertise": {
        "name": "Automotive / Aerospace",
        "code": "automotive-aerospace"
      },
      "status_summary": "PENDING",
      "child_project": [],
      "tags": [
       {
        "tag": "test tag"
       },
       {
        "tag": "test tag 2"
       }
      ],
      "custom_fields": []
     },
    .
    .
    .
    ]
  },
 "errors":[]
}