Sign in

v2

latestOpenAPI 3.0.02026-08-07103189636.5 KB
Jobs

List jobs within a project

List / search the jobs within a project. By default, only the last 50 jobs are returned. Use the <code>limit</code> and <code>offset</code> parameters to return more than 50 jobs. <a href="https://help.smartling.com/hc/en-us/articles/1260805176869-Pagination" target="_blank">Learn more.</a>

get/jobs-api/v3/projects/{projectId}/jobs

Path parameters

projectIdstring required

A unique project identifier. This can be found in the Smartling Dashboard under Account Settings > API.

Query parameters

jobNamestring

Used for searching jobs by jobName. Any entry is treated as a LIKE query on the name of the job.

jobNumberstring

Used for searching jobs by jobNumber. Search works by exact comparison.

translationJobUidsstring[]

Used for searching jobs by translationJobUid. Supports up to 500 translationJobUids.

translationJobStatusstring[]

Used for searching jobs by their status.

limitinteger

The limit on the number of jobs returned.

offsetinteger

The offset to use when searching for jobs.

sortBy'createdDate' | 'dueDate' | 'jobName'

The field to sort by.

sortDirection'ASC' | 'DESC'

The direction to sort.

Response

OK

Example response

{
  "response": {
    "data": {
      "items": [
        {
          "createdDate": "2015-11-21T01:51:17.000Z",
          "dueDate": "2015-11-21T01:51:17.000Z",
          "jobNumber": "SMTL-123",
          "jobStatus": "DRAFT | AWAITING_AUTHORIZATION | IN_PROGRESS | COMPLETED | CANCELLED | CLOSED",
          "targetLocaleIds": [
            "de-DE"
          ],
          "referenceNumber": "CustomerReferenceNum1"
        }
      ]
    }
  }
}