Skip to content
API Reference
/
/
Retrieve Workflow Configu...

Retrieve Workflow Configuration Based on ID

Request

Retrieve Workflow Configuration based on ID

Security
api_key
Path
idstringrequired

Unique identifier of the Workflow Configuration 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.acc.connect.easypost.eu/_mock/public-api/openapi/workflows/{id}' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-managed-company-id: string'

Responses

Successful response with the Workflow Configuration

Bodyapplication/json
triggerWorkflowFileDropTriggerDto (object) or WorkflowScheduledTriggerDto (object)required
One of:
tasksArray of anyrequired
inputSourceWorkflowPDFInputSourceDto (object) or WorkflowPayloadPdfInputSourceDto (object) or WorkflowPayloadWordInputSourceDto (object) or WorkflowDataFileInputSourceDto (object) or WorkflowUblInputSourceDto (object)required
One of:
namestringrequired
descriptionstring
enabledbooleanrequired
sFTPFolderNamestring
validatedbooleanrequired
pomobject(PomConfigurationDto)
isDeletedboolean
requiresApprovalbooleanrequired
invoiceConfigurationobject(InvoiceConfigurationDto)
dateFormatstring
Enum:"yyyy/MM/dd""dd/MM/yyyy""yyyy-MM-dd""dd-MM-yyyy"
ttlnumber
dataRetentionobject(WorkflowDataRetentionDto)
companyIdstringrequired
departmentIdstringrequired
idstringrequired
modelVersionstring
lastModifiedAtstringrequired
lastModifiedBystringrequired
versionnumberrequired
createdAtstringrequired
watermarkobject(WatermarkDto)
Response
{
  "trigger": {
    "type": "FILE_DROP",
    "secondsToWait": 0
  },
  "tasks": [
    { … }
  ],
  "inputSource": {
    "type": "PDF",
    "channelIdentifiers": [ … ],
    "splitIdentifiers": [ … ],
    "ignoreIdentifiers": [ … ],
    "extraInfoIdentifiers": [ … ],
    "textExtractionMethod": "OCR",
    "sampleFile": { … }
  },
  "name": "string",
  "description": "string",
  "enabled": true,
  "sFTPFolderName": "string",
  "validated": true,
  "pom": {
    "language": "EN",
    "requestOptIn": true,
    "qrCodePosition": { … },
    "width": 0
  },
  "isDeleted": true,
  "requiresApproval": true,
  "invoiceConfiguration": {
    "enableInvoiceTracking": true,
    "dueDateFormat": "yyyy/MM/dd"
  },
  "dateFormat": "yyyy/MM/dd",
  "ttl": 0,
  "dataRetention": {
    "job": { … },
    "sendingEvent": { … }
  },
  "companyId": "string",
  "departmentId": "string",
  "id": "string",
  "modelVersion": "string",
  "lastModifiedAt": "string",
  "lastModifiedBy": "string",
  "version": 0,
  "createdAt": "string",
  "watermark": {
    "x": 0,
    "y": 0,
    "width": 0,
    "location": "FIRST_PAGE",
    "height": 0,
    "image": { … }
  }
}