Jobs

Get job by ID

get/v3/jobs/{id}

Request

Base URL
https://integrators.prod.api.tabsplatform.com
Auth
API key in header Authorization
TypeScript
https://skmtc.dev/tabsplatform/apis/tabs-external-api/docs/v3/jobs/:id/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

idstring required

Example:123e4567-e89b-12d3-a456-426614174000

Job Id

Response

Job Status

successboolean required

Boolean with true=success, false=failure

messagestring required

Plain-text description of the result

Example response

{
  "payload": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "status": "NEW",
    "type": "SYNC",
    "processStartedAt": "2024-03-20T10:00:00Z",
    "startedAt": "2024-03-20T10:00:00Z",
    "finishedAt": "2024-03-20T10:05:00Z",
    "details": "Processing 100 records",
    "results": {
      "data": {
        "customerId": "123"
      },
      "status": "SUCCESS"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.