---
title: "GET /v1/workflows/{workflowId}"
method: GET
path: "/v1/workflows/{workflowId}"
---

# GET /v1/workflows/{workflowId}

`GET /v1/workflows/{workflowId}`

## Path parameters

- `workflowId` number, required

## Response `200`

- WorkflowEntity
  - `id` number, required
  - `identifier` string, required
  - `category` CategoryEntity
    - `id` number, required
    - `app` AppEntity, required
      - `id` number, required
      - `clientId` number, required
      - `apiKey` string, required
      - `notificationEnabled` boolean, required
      - `name` string, required
      - `url` string, required
      - `channelProviders` AppChannelProviderEntity[], required
        - `id` number, required
        - `app` AppEntity, required — recursive
        - `channel` object, required
        - `provider` ProviderEntity, required
          - `identifier` object, required
          - `name` string, required
          - `description` string, nullable, required
          - `integrationMessage` string, required
          - `icon` string, nullable, required
          - `channel` object, required
          - `configOptions` ProviderConfigOptionEntity[], required
            - `id` number, required
            - `provider` ProviderEntity, required — recursive
            - `config` string, required
            - `required` boolean, required
            - `description` string, required
          - `isActive` boolean, required
          - `createdAt` string, date-time, required
          - `updatedAt` string, date-time, required
          - `deletedAt` string, date-time, required
        - `configs` AppChannelProviderConfigEntity[], required
          - `id` number, required
          - `appChannelProvider` AppChannelProviderEntity, required — recursive
          - `config` string, required
          - `value` string, required
          - `isEncrypted` boolean, required
          - `appChannelProviderId` number
        - `enabled` boolean, required
        - `deliveryOrder` number, required
        - `selectionCondition` string, nullable
        - `notificationCount` number
        - `instanceName` string, nullable
      - `type` object, required
      - `subdomain` string, nullable, required
      - `apiSecret` string, required
      - `gcmKey` string, nullable, required
      - `senderId` string, nullable, required
      - `domain` string, nullable, required
      - `welcomeMessage` string, required
      - `customEvents` string, nullable, required
      - `optInType` object, required
      - `prePrompt` number, required
      - `serviceWorkerPath` string, nullable, required
      - `xPos` number, required
      - `yPos` number, required
      - `defaultPosition` string, required
      - `posTop` number, nullable, required
      - `posBottom` number, nullable, required
      - `posLeft` number, nullable, required
      - `posRight` number, nullable, required
      - `promptDelay` number, required
      - `bgcolor` string, nullable, required
      - `fcolor` string, nullable, required
      - `confirmationButtonText` string, required
      - `declineButtonText` string, required
      - `lastCheckedForCodeIntegration` string, date-time, required
      - `disableUserActivityTrackingByDefault` number, required
      - `disableLocationIpTracking` number, required
      - `websiteType` object, required
      - `siteOnboardingCompleted` number, required
      - `panelUiStyle` string, required
      - `widgetType` string, nullable, required
      - `bellIconDivId` string, nullable, required
      - `websiteIcon` string, nullable, required
      - `onBoardingStepsCompleted` object, nullable, required
      - `playSound` number, required
      - `vapidPrivateKey` string, required
      - `vapidPublicKey` string, required
      - `hideBranding` boolean, required
      - `enableUserSignatureVerification` boolean, required
      - `enableWebPush` boolean, required
      - `rsaPublicKey` string, nullable, required
      - `rtmProvider` object, required
      - `secureAuth` boolean, required
      - `deletedAt` string, date-time
      - `inAppCodeIntegration` boolean, required
      - `webPushCodeIntegration` boolean, required
      - `isDefault` boolean
      - `isProduction` boolean
      - `order` number
    - `name` string, required
    - `identifier` string, required
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required
    - `deletedAt` string, date-time, required
    - `hideInPreferenceManager` boolean, required
    - `hideInInApp` boolean, required
  - `name` string, required
  - `app` AppEntity, required
    - `id` number, required
    - `clientId` number, required
    - `apiKey` string, required
    - `notificationEnabled` boolean, required
    - `name` string, required
    - `url` string, required
    - `channelProviders` AppChannelProviderEntity[], required
      - `id` number, required
      - `app` AppEntity, required — recursive
      - `channel` object, required
      - `provider` ProviderEntity, required
        - `identifier` object, required
        - `name` string, required
        - `description` string, nullable, required
        - `integrationMessage` string, required
        - `icon` string, nullable, required
        - `channel` object, required
        - `configOptions` ProviderConfigOptionEntity[], required
          - `id` number, required
          - `provider` ProviderEntity, required — recursive
          - `config` string, required
          - `required` boolean, required
          - `description` string, required
        - `isActive` boolean, required
        - `createdAt` string, date-time, required
        - `updatedAt` string, date-time, required
        - `deletedAt` string, date-time, required
      - `configs` AppChannelProviderConfigEntity[], required
        - `id` number, required
        - `appChannelProvider` AppChannelProviderEntity, required — recursive
        - `config` string, required
        - `value` string, required
        - `isEncrypted` boolean, required
        - `appChannelProviderId` number
      - `enabled` boolean, required
      - `deliveryOrder` number, required
      - `selectionCondition` string, nullable
      - `notificationCount` number
      - `instanceName` string, nullable
    - `type` object, required
    - `subdomain` string, nullable, required
    - `apiSecret` string, required
    - `gcmKey` string, nullable, required
    - `senderId` string, nullable, required
    - `domain` string, nullable, required
    - `welcomeMessage` string, required
    - `customEvents` string, nullable, required
    - `optInType` object, required
    - `prePrompt` number, required
    - `serviceWorkerPath` string, nullable, required
    - `xPos` number, required
    - `yPos` number, required
    - `defaultPosition` string, required
    - `posTop` number, nullable, required
    - `posBottom` number, nullable, required
    - `posLeft` number, nullable, required
    - `posRight` number, nullable, required
    - `promptDelay` number, required
    - `bgcolor` string, nullable, required
    - `fcolor` string, nullable, required
    - `confirmationButtonText` string, required
    - `declineButtonText` string, required
    - `lastCheckedForCodeIntegration` string, date-time, required
    - `disableUserActivityTrackingByDefault` number, required
    - `disableLocationIpTracking` number, required
    - `websiteType` object, required
    - `siteOnboardingCompleted` number, required
    - `panelUiStyle` string, required
    - `widgetType` string, nullable, required
    - `bellIconDivId` string, nullable, required
    - `websiteIcon` string, nullable, required
    - `onBoardingStepsCompleted` object, nullable, required
    - `playSound` number, required
    - `vapidPrivateKey` string, required
    - `vapidPublicKey` string, required
    - `hideBranding` boolean, required
    - `enableUserSignatureVerification` boolean, required
    - `enableWebPush` boolean, required
    - `rsaPublicKey` string, nullable, required
    - `rtmProvider` object, required
    - `secureAuth` boolean, required
    - `deletedAt` string, date-time
    - `inAppCodeIntegration` boolean, required
    - `webPushCodeIntegration` boolean, required
    - `isDefault` boolean
    - `isProduction` boolean
    - `order` number
  - `isActive` boolean, required
  - `jsonSpec` object, required
  - `createdAt` string, date-time, required
  - `updatedAt` string, date-time, required
  - `deletedAt` string, date-time, required
  - `hasUnpublishedChanges` boolean, required
  - `versions` WorkflowVersionEntity[], required
    - `id` number, required
    - `workflowId` string, required
    - `workflow` WorkflowEntity, required — recursive
    - `steps` WorkflowStepEntity[], required
      - `id` number, required
      - `ref` string, required
      - `stepOrder` number, required
      - `type` 'branch' | 'delay' | 'channel' | 'batch' | 'waitForInput' | 'updatePreference' | 'fetch' | 'triggerWorkflow' | 'defineVariable' | 'editVariable', required
      - `config` object, required
      - `template` object, nullable, required
      - `channelKey` object, required
      - `triggerCondition` string, required
      - `workflow` WorkflowEntity, required — recursive
      - `workflowVersion` WorkflowVersionEntity, required — recursive
      - `belongsToBranch` WorkflowBranchEntity, required
        - `id` number, required
        - `branchCondition` string, nullable, required
        - `name` string, nullable, required
        - `ref` string, nullable, required
        - `branchFromStep` WorkflowStepEntity, required — recursive
      - `branches` WorkflowBranchEntity[], required
        - `id` number, required
        - `branchCondition` string, nullable, required
        - `name` string, nullable, required
        - `ref` string, nullable, required
        - `branchFromStep` WorkflowStepEntity, required — recursive
      - `createdAt` string, date-time, required
      - `updatedAt` string, date-time, required
      - `deletedAt` string, date-time, required
    - `isActive` boolean, required
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required
    - `deletedAt` string, date-time, required
  - `clientUser` ClientUserEntity
    - `id` number, required
    - `firstName` string, required
    - `lastName` string, required
    - `address` string, required
    - `profilePicture` string, required
    - `email` string, required
    - `password` string, required
    - `address2` string, required
    - `city` string, required
    - `postcode` string, required
    - `country` string, required
    - `state` string, required
    - `cc` number, required
    - `phone` string, required
    - `activationHash` string, required
    - `activationEmailResentAt` string, date-time, required
    - `passwordLockedAt` string, date-time, required
    - `accountStatus` object, required
    - `emailVerified` boolean, required
    - `timezone` string, required
    - `registeredIp` string, required
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required
    - `aid` string, required
    - `emailList` object, required
    - `onboardingCompleted` number, required
    - `lastCheckedForInactivity` string, date-time, required
    - `receiveNewsletters` number, required
    - `lastLogin` string, date-time, required
    - `gitHubId` number, required
    - `googleId` number, required
    - `clients` ClientEntity[], required
      - `id` number, required
      - `name` string, required
      - `createdAt` string, date-time, required
      - `updatedAt` string, date-time, required
      - `stripeId` string, required
      - `stripePaymentId` string, required
      - `defaultApp` number, required
      - `clientUsers` ClientUserEntity[], required
      - `clientUserClients` ClientUserClientsEntity[], required
        - `mappingId` number, required
        - `role` object, required
        - `clientUser` ClientUserEntity, required — recursive
        - `client` ClientEntity, required — recursive
      - `licenseKey` string
      - `licensePublicKey` string
      - `licenseAuthToken` string
      - `status` 'active' | 'send_suspended' | 'suspended', required
      - `version` string
      - `region` string
    - `clientUserClients` ClientUserClientsEntity[], required
      - `mappingId` number, required
      - `role` object, required
      - `clientUser` ClientUserEntity, required — recursive
      - `client` ClientEntity, required
        - `id` number, required
        - `name` string, required
        - `createdAt` string, date-time, required
        - `updatedAt` string, date-time, required
        - `stripeId` string, required
        - `stripePaymentId` string, required
        - `defaultApp` number, required
        - `clientUsers` ClientUserEntity[], required
        - `clientUserClients` ClientUserClientsEntity[], required
        - `licenseKey` string
        - `licensePublicKey` string
        - `licenseAuthToken` string
        - `status` 'active' | 'send_suspended' | 'suspended', required
        - `version` string
        - `region` string
    - `source` string
    - `isTwoFactorEnabled` number, required
    - `twoFactorSecret` string
    - `passwordResetRequestedAt` string, date-time, required

---

[API](https://skmtc.net/engagespot/apis/engagespot-api.md) · [All operations](https://skmtc.net/engagespot/apis/engagespot-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/engagespot/engagespot-api/revisions/33fd027f0b5f/schema)