# Retrieve Workflow Configuration Based on ID

Retrieve Workflow Configuration based on ID

Endpoint: GET /workflows/{id}
Version: 1.0.0
Security: api_key

## Security:

  - `api_key` (unknown)
    apiKey in header x-api-key

## Path parameters:

  - `id` (string, required)
    Unique identifier of the Workflow Configuration to be retrieved

## Header parameters:

  - `x-managed-company-id` (string)
    Optional: the ID of the managed company on behalf of which the request is made

## Response 200:

  - `200` (unknown)
    Successful response with the Workflow Configuration

## Response 200 fields (application/json):

  - `trigger` (any, required)

  - `trigger.type` (string, required)
    Enum: "FILE_DROP"

  - `trigger.secondsToWait` (number, required)

  - `trigger.type` (string, required)
    Enum: "SCHEDULED"

  - `trigger.scheduleTime` (object, required)

  - `trigger.scheduleTime.hours` (number, required)

  - `trigger.scheduleTime.minutes` (number, required)

  - `trigger.timezone` (string, required)

  - `tasks` (array, required)

  - `tasks.taskType` (string, required)
    Enum: "EASY_PRINT", "EASY_PRINT_FR"

  - `tasks.mergeDocuments` (boolean, required)

  - `tasks.resources` (object, required)

  - `tasks.resources.paper` (object, required)

  - `tasks.resources.paper.type` (string, required)
    Enum: "A4_5GR"

  - `tasks.resources.paper.logo` (object)

  - `tasks.resources.paper.logo.filename` (string, required)

  - `tasks.print` (object, required)

  - `tasks.print.addFrontPageFromStructuredAddress` (boolean)
    Indicates whether a front page is added using the structured address fields. If set to false, the address block must fit entirely within the envelope address window.

  - `tasks.print.addFrontPage` (boolean, required)

  - `tasks.print.printColor` (string, required)
    Enum: "BW", "COLORS"

  - `tasks.print.printSide` (string, required)
    Enum: "RECTO", "RECTO_VERSO"

  - `tasks.deliveryType` (string, required)
    Enum: "PRIOR", "NON_PRIOR", "REGISTERED"

  - `tasks.attachment` (object)

  - `tasks.attachment.filename` (string, required)

  - `tasks.attachment.originalFilename` (string)

  - `tasks.attachment.position` (string, required)
    Enum: "VERSO_ALL_PAGES", "END_OF_DOCUMENT"

  - `tasks.externalId` (string)

  - `tasks.envelopeLayout` (object, required)

  - `tasks.envelopeLayout.id` (string)

  - `tasks.envelopeLayout.windowSide` (string, required)
    Enum: "RIGHT", "LEFT"

  - `tasks.envelopeLayout.format` (string)
    Enum: "US", "C5", "C4"

  - `tasks.envelopeLayout.isDefault` (boolean)

  - `tasks.fallbackC4Envelope` (object)

  - `tasks.fallbackC4Envelope.id` (string)

  - `tasks.fallbackC4Envelope.isDefault` (boolean, required)

  - `tasks.extraInfoReferenceName` (string)

  - `tasks.id` (string, required)

  - `tasks.name` (string, required)

  - `tasks.description` (string)

  - `tasks.validationStatus` (string, required)
    Enum: "PENDING", "VALIDATED", "ERROR", "VALIDATION_NOT_STARTED"

  - `tasks.validationErrors` (array, required)

  - `tasks.validationErrors.code` (string, required)
    Error code representing the type of error

  - `tasks.validationErrors.message` (string, required)
    Error message providing more details about the error

  - `tasks.validationErrors.timestamp` (string, required)
    Timestamp when the error occurred

  - `tasks.modelVersion` (string)

  - `tasks.maxDurationInSeconds` (number, required)

  - `tasks.supplierId` (string, required)

  - `tasks.taskType` (string, required)
    Enum: "EMAIL"

  - `tasks.sender` (object, required)

  - `tasks.sender.emailAddress` (string, required)

  - `tasks.sender.displayName` (string, required)

  - `tasks.subject` (string, required)

  - `tasks.bodyTemplate` (object, required)

  - `tasks.bodyTemplate.filename` (string, required)

  - `tasks.bodyTemplate.originalFilename` (string)

  - `tasks.taskType` (string, required)
    Enum: "ERDS"

  - `tasks.identificationMethods` (array)

  - `tasks.portalLanguage` (string, required)
    Enum: "EN", "NL", "FR"

  - `tasks.attachments` (array, required)

  - `tasks.taskType` (string, required)
    Enum: "QERDS"

  - `tasks.taskType` (string, required)
    Enum: "EBOX"

  - `tasks.senderApplicationId` (string, required)

  - `tasks.messageTypeId` (string, required)

  - `tasks.partition` (string, required)

  - `tasks.isRegisteredMail` (boolean, required)

  - `tasks.taskType` (string, required)
    Enum: "DOCCLE"

  - `tasks.classificationLevel` (string, required)
    Enum: "Public", "Confidential", "HighlyConfidential"

  - `tasks.documentType` (string, required)

  - `tasks.documentDisplay` (object, required)

  - `tasks.documentDisplay.defaultLanguage` (string, required)
    Enum: "EN", "NL", "FR"

  - `tasks.documentDisplay.name` (object, required)

  - `tasks.documentDisplay.name.EN` (string, required)

  - `tasks.documentDisplay.name.NL` (string, required)

  - `tasks.documentDisplay.name.FR` (string, required)

  - `tasks.taskType` (string, required)
    Enum: "PEPPOL"

  - `tasks.supplierId` (string, required)
    Enum: "NYMUS", "BILLIT"

  - `inputSource` (any, required)

  - `inputSource.type` (string, required)
    Enum: "PDF"

  - `inputSource.channelIdentifiers` (array, required)

  - `inputSource.channelIdentifiers.regionOfInterest` (object, required)

  - `inputSource.channelIdentifiers.regionOfInterest.x1` (number, required)

  - `inputSource.channelIdentifiers.regionOfInterest.y1` (number, required)

  - `inputSource.channelIdentifiers.regionOfInterest.x2` (number, required)

  - `inputSource.channelIdentifiers.regionOfInterest.y2` (number, required)

  - `inputSource.channelIdentifiers.kind` (string, required)
    Enum: "ADDRESS", "ADDRESS_FIRST_NAME", "ADDRESS_LAST_NAME", "ADDRESS_COMPANY_NAME", "ADDRESS_STREET", "ADDRESS_STREET_NUMBER", "ADDRESS_BOX", "ADDRESS_PO_BOX", "ADDRESS_POSTAL_CODE", "ADDRESS_CITY", "ADDRESS_COUNTRY_CODE", "EMAIL_ADDRESS", "PHONE_NUMBER", "LAST_NAME", "FIRST_NAME", "BIRTH_DATE", "INVOICE_AMOUNT", "INVOICE_DESCRIPTION", "INVOICE_DUE_DATE", "INVOICE_PAY_LINK", "INVOICE_PAY_LINK_SHORT", "INVOICE_COMMUNICATION", "INVOICE_PAYMENT_DATE", "POM_OPT_IN_EMAIL", "COMPANY_IDENTIFICATION_NUMBER", "NATIONAL_REGISTER_NUMBER", "EBOX_RECIPIENT_PARTITION", "INVOICE_REFERENCE", "DOCCLE_TOKEN_SET_VALUE1", "DOCCLE_TOKEN_SET_VALUE2", "DOCCLE_RECEIVER_ID", "DOCCLE_TOKEN_SET_START_DATE", "DOCCLE_TOKEN_SET_END_DATE", "PEPPOL_SENDER_PARTICIPANT_ID", "PEPPOL_RECEIVER_PARTICIPANT_ID", "PEPPOL_DOCUMENT_ID", "PEPPOL_ISSUE_DATE", "PEPPOL_DOCUMENT_TYPE"

  - `inputSource.channelIdentifiers.source` (string, required)
    Enum: "PDF", "DATA_FILE", "PAYLOAD"

  - `inputSource.channelIdentifiers.mustBeEncrypted` (boolean)

  - `inputSource.splitIdentifiers` (array, required)

  - `inputSource.splitIdentifiers.channelProperty` (string)
    Enum: "ADDRESS", "EMAIL_ADDRESS"

  - `inputSource.splitIdentifiers.kind` (string, required)
    Enum: "RECIPIENT_ID", "REGEX", "TEXT", "EMPTY_TEXT", "CHANGE_OF_TEXT"

  - `inputSource.splitIdentifiers.splitOnChange` (boolean, required)

  - `inputSource.splitIdentifiers.value` (string)

  - `inputSource.ignoreIdentifiers` (array, required)

  - `inputSource.ignoreIdentifiers.kind` (string, required)
    Enum: "REGEX", "TEXT", "EMPTY_TEXT"

  - `inputSource.ignoreIdentifiers.value` (string)

  - `inputSource.extraInfoIdentifiers` (array, required)

  - `inputSource.extraInfoIdentifiers.name` (string, required)

  - `inputSource.extraInfoIdentifiers.source` (string, required)
    Enum: "PDF", "DATA_FILE", "PAYLOAD"

  - `inputSource.extraInfoIdentifiers.mustBeEncrypted` (boolean)

  - `inputSource.textExtractionMethod` (string, required)
    Enum: "OCR", "TEXT_LAYER"

  - `inputSource.type` (string, required)
    Enum: "PAYLOAD_PDF"

  - `inputSource.type` (string, required)
    Enum: "PAYLOAD_WORD"

  - `inputSource.type` (string, required)
    Enum: "CSV", "XML"

  - `inputSource.fieldDescriptions` (array, required)

  - `inputSource.type` (string, required)
    Enum: "UBL"

  - `name` (string, required)

  - `description` (string)

  - `enabled` (boolean, required)

  - `sFTPFolderName` (string)

  - `validated` (boolean, required)

  - `pom` (object)

  - `pom.language` (string, required)
    Enum: "EN", "NL", "FR", "DE"

  - `pom.requestOptIn` (boolean, required)

  - `pom.qrCodePosition` (object)

  - `pom.qrCodePosition.x` (number, required)

  - `pom.qrCodePosition.y` (number, required)

  - `pom.width` (number)

  - `isDeleted` (boolean)

  - `requiresApproval` (boolean, required)

  - `invoiceConfiguration` (object)

  - `invoiceConfiguration.enableInvoiceTracking` (boolean, required)

  - `invoiceConfiguration.dueDateFormat` (string, required)
    Enum: "yyyy/MM/dd", "dd/MM/yyyy", "yyyy-MM-dd", "dd-MM-yyyy"

  - `dateFormat` (string)
    Enum: "yyyy/MM/dd", "dd/MM/yyyy", "yyyy-MM-dd", "dd-MM-yyyy"

  - `ttl` (number)

  - `dataRetention` (object)

  - `dataRetention.job` (object)

  - `dataRetention.job.periodInSeconds` (number, required)

  - `companyId` (string, required)

  - `departmentId` (string, required)

  - `id` (string, required)

  - `modelVersion` (string)

  - `lastModifiedAt` (string, required)

  - `lastModifiedBy` (string, required)

  - `version` (number, required)

  - `createdAt` (string, required)

  - `watermark` (object)

  - `watermark.x` (number)

  - `watermark.y` (number)

  - `watermark.width` (number, required)

  - `watermark.location` (string, required)
    Enum: "FIRST_PAGE", "ALL_PAGES", "SPECIFIC_PAGES"

  - `watermark.height` (number, required)

## Response 403:

  - `403` (unknown)
    Workflow configuration cannot be accessed with the current API client permissions

## Response 404:

  - `404` (unknown)
    Workflow configuration with the specified ID not found