Skip to content
/Jobs

Jobs

Entity representing the grouping of one or multiple sendings, created simultaneously from the same resource file (PDF, ZIP, CSV or XML). All the Job mails, internally referred to as SendingEvents, will share the same job ID. The Job is linked to one specific Workflow used to describe all the channels to be used to reach the recipient.

Operations

Retrieve Job Based on ID

Request

Retrieve Job based on ID

Security
api_key
Path
idstringrequired

Unique identifier of the Job to be retrieved

Headers
x-managed-company-idstring

Optional: the ID of the managed company on behalf of which the request is made

curl -i -X GET \
  'https://doc.connect.easypost.eu/_mock/public-api/openapi/jobs/{id}' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-managed-company-id: string'

Responses

Bodyapplication/json
idstringrequired

Unique identifier of the Job

namestringrequired

Name of the Job

startDatestring, (date-time)required

The Datetime denoting the moment of Job creation

statusstringrequired

Status of the Job

Enum:"AWAITING_FILE_UPLOAD""WAITING""PROCESSING""OK""ACTION_REQUIRED""ERROR""CANCELLED"
pendingEsigningApprovalCountnumber

Number of eSigning documents awaiting approval after signing

originalFilenamestringrequired

Name of the the file used to create the Job

executionDatestring, (date-time)required

Datetime of the moment when the SendingEvents of the Job are created

sendingEventExecutionDateUtcstring, (date-time)

Datetime of the scheduled SendingEvents execution in UTC

authorstring

Name of the user who submitted the Job

approvalobject(ApprovalDto)

The approval information for the job

sendingEventsobject(SendingEventsCount)required

SendingEvents count details

errorListArray of objects(CustomErrorDto)required

List of errors for the job

warningListArray of objects(CustomErrorDto)required

List of warnings for the job

workflowIdstringrequired

Unique identifier of the workfow used to process the Job

Response
{
  "id": "string",
  "name": "string",
  "startDate": "2019-08-24T14:15:22Z",
  "status": "AWAITING_FILE_UPLOAD",
  "pendingEsigningApprovalCount": 0,
  "originalFilename": "string",
  "executionDate": "2019-08-24T14:15:22Z",
  "sendingEventExecutionDateUtc": "2019-08-24T14:15:22Z",
  "author": "string",
  "approval": {
    "status": "PREPARING_FOR_APPROVAL",
    "userId": "string",
    "username": "string",
    "timestamp": "2019-08-24T14:15:22Z"
  },
  "sendingEvents": {
    "ok": 0,
    "warning": 0,
    "total": 0
  },
  "errorList": [
    { … }
  ],
  "warningList": [
    { … }
  ],
  "workflowId": "string"
}