Sign in

v2

latestOpenAPI 3.0.02026-08-07103189636.5 KB
Jobs

List jobs within an account

List / search the jobs within an account. 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/accounts/{accountUid}/jobs

Path parameters

accountUidstring required

A unique account 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.

projectIdsstring[]

Used for searching jobs by projectId. Supports up to 500 projectIds.

translationJobStatusstring[]

Used for searching jobs by their status.

withPriorityboolean

If set to true, returns jobs only with priority.

limitinteger

The limit on the number of jobs returned.

offsetinteger

The offset to use when searching for jobs.

sortBy'createdDate' | 'priority'

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 | DELETED",
          "priority": 2,
          "projectId": "fd7244365",
          "referenceNumber": "CustomerReferenceNum1",
          "targetLocaleIds": [
            "de-DE"
          ]
        }
      ]
    }
  }
}