> ## Documentation Index
> Fetch the complete documentation index at: https://developers.logicgate.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Find a specific workflow

> Retrieves the full workflow summary for the given workflow ID.



## OpenAPI

````yaml GET /api/v1/workflows/{workflow}
openapi: 3.1.0
info:
  title: Risk Cloud API
  description: >-
    The Risk Cloud API is a collection of RESTful API endpoints that empower you
    and your team to directly integrate, automate, and build with the Risk
    Cloud. Risk Cloud API endpoint payloads are JSON based, with some endpoints
    supporting exports in CSV and XSLX formats for flexible integration.


    This API documentation showcases our Risk Cloud API v1, containing a variety
    of endpoints with continued support for enabling integrations with the Risk
    Cloud.


    Visit the [LogicGate Risk Cloud Developer
    Portal](https://www.logicgate.com/developer/) to get started with building
    your custom integration with quick start guides, usage guides, release
    notes, and more. Or download the [v1 OpenAPI
    specification](/legacy-openapi.json).


    Explore our [Risk Cloud API v2](https://docs.logicgate.com/v2/index.html)
    endpoints and documentation as well. [Risk Cloud API
    v2](https://docs.logicgate.com/v2/index.html) is our collection of API-First
    endpoints that are tailor made for our developer users, offer concise and
    highly documented details, are supported by a [Postman
    collection](https://www.postman.com/logicgate-postman/workspace/logicgate-risk-cloud-api/collection/29257227-de8d264b-6eeb-4177-bea6-2da0a8cabffc)
    and [v2 OpenAPI specification](https://github.com/LogicGateTech/openapi),
    and contain our latest API endpoint releases.
  contact:
    name: developer-relations@logicgate.com
    email: developer-relations@logicgate.com
  version: v2026.11.0
servers:
  - url: https://{subdomain}.logicgate.com
    description: Your Risk Cloud environment.
    variables:
      subdomain:
        description: Your Risk Cloud environment's subdomain (e.g. `qa`).
        default: your-instance
security:
  - ApiToken: []
  - basic: []
tags:
  - name: Authentication
    description: >-
      Getting Started: How to create an [API Access
      Token](https://www.logicgate.com/developer/risk-cloud-api-authentication/)
      to begin integrating with the Risk Cloud API
  - name: Attachment
    description: Endpoints for uploading, downloading, and retrieving record attachments.
  - name: Field
    description: Endpoints for creating, updating, and querying fields.
  - name: Principal
    description: >-
      Endpoints for the authenticated principal to view and manage their own
      details.
  - name: Record Audit
    description: Endpoints for retrieving record audit history and productivity data.
  - name: Step
    description: Endpoints for retrieving steps and the steps a user can access.
  - name: Table Report
    description: Endpoints for retrieving and managing table reports.
  - name: User Group
    description: Endpoints for managing user groups and their membership.
externalDocs:
  description: Developer Portal
  url: https://www.logicgate.com/developer/
paths:
  /api/v1/workflows/{workflow}:
    get:
      tags:
        - Workflow
      summary: Find a specific workflow.
      description: Retrieves the full workflow summary for the given workflow ID.
      operationId: getById_2
      parameters:
        - name: workflow
          in: path
          description: ID of the workflow to return.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Workflow_ExtendedWorkflowSummary'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppStatusResponse_ExtendedWorkflowSummary'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppStatusResponse_ExtendedWorkflowSummary'
components:
  schemas:
    Workflow_ExtendedWorkflowSummary:
      type: object
      description: >-
        An entity that contains information about a set of steps within a
        particular application.
      discriminator:
        propertyName: workflowType
      oneOf:
        - description: Circular reference to ControlWorkflow_ExtendedWorkflowSummary
        - description: 'And other types: JiraWorkflow_ExtendedWorkflowSummary'
      properties:
        id:
          type: string
        active:
          type: boolean
        created:
          type: string
          format: date-time
        updated:
          type: string
          format: date-time
        name:
          type: string
          description: Name of the workflow.
        description:
          type: string
          description: Description of the workflow.
          maxLength: 2000
          minLength: 0
        recordPrefix:
          type: string
          description: Name to be used for every record created from the workflow.
        allowGroups:
          type: boolean
          description: Nodes created in the workflow are allowed user groups.
        requireGroups:
          type: boolean
          description: Nodes created in the workflow require user groups.
        xpos:
          type: integer
          format: int32
          description: X axis position of the workflow on the application screen
        ypos:
          type: integer
          format: int32
          description: Y axis position of the workflow on the application screen
        priority:
          type: integer
          format: int32
          description: >-
            Determines the workflow's place in the application. Priority is in
            descending order with 0 being the first workflow.
        sla:
          $ref: '#/components/schemas/ServiceLevelAgreement_ExtendedWorkflowSummary'
          description: Object containing all SLA information.
        allowAec:
          type: boolean
          description: Enables automated evidence collection.
        allowRcsa:
          type: boolean
          description: Allow Risk & Control Self-Assessments.
        sequence:
          $ref: '#/components/schemas/WorkflowSequence_ExtendedWorkflowSummary'
        application:
          $ref: '#/components/schemas/Application_ExtendedWorkflowSummary'
          description: Application that the workflow belongs to.
        userGroups:
          type: array
          description: User groups that are allowed access to the workflow
          items:
            $ref: '#/components/schemas/UserGroup_ExtendedWorkflowSummary'
        primaryField:
          $ref: '#/components/schemas/PrimaryField_ExtendedWorkflowSummary'
        workflowType:
          type: string
          enum:
            - WORKFLOW
            - JIRA_WORKFLOW
            - CONTROL_WORKFLOW
            - ANALYSIS_WORKFLOW
        currentValueUserGroupMappings:
          type: array
          items:
            $ref: >-
              #/components/schemas/CurrentValueUserGroupMapping_ExtendedWorkflowSummary
        automatedAccessEnabled:
          type: boolean
        automatedAccessFields:
          type: array
          description: Fields that triggers automated access changes
          items:
            $ref: '#/components/schemas/Field_ExtendedWorkflowSummary'
          maxItems: 6
          minItems: 0
        automatedAccessFieldId:
          type: string
        summaryFields:
          type: array
          items:
            $ref: '#/components/schemas/WorkflowSummaryField_ExtendedWorkflowSummary'
          maxItems: 5
          minItems: 0
        contains:
          description: Circular reference to Workflow_ExtendedWorkflowSummary
          writeOnly: true
        canSelect:
          description: Circular reference to Workflow_ExtendedWorkflowSummary
          writeOnly: true
        pluralizedRecordPrefix:
          type: string
      required:
        - active
        - allowAec
        - allowGroups
        - allowRcsa
        - application
        - automatedAccessEnabled
        - automatedAccessFieldId
        - automatedAccessFields
        - created
        - currentValueUserGroupMappings
        - description
        - id
        - name
        - primaryField
        - priority
        - recordPrefix
        - requireGroups
        - sequence
        - sla
        - summaryFields
        - updated
        - userGroups
        - workflowType
        - xpos
        - ypos
    AppStatusResponse_ExtendedWorkflowSummary:
      type: object
      properties:
        type:
          type: string
          format: uri
        title:
          type: string
        status:
          type: integer
          format: int32
        detail:
          type: string
        instance:
          type: string
          format: uri
        properties:
          type: object
          additionalProperties: {}
    ServiceLevelAgreement_ExtendedWorkflowSummary:
      type: object
      properties:
        enabled:
          type: boolean
        duration:
          type: integer
          format: int64
      required:
        - duration
        - enabled
    WorkflowSequence_ExtendedWorkflowSummary:
      type: object
      properties:
        id:
          type: string
        active:
          type: boolean
        created:
          type: string
          format: date-time
        updated:
          type: string
          format: date-time
      required:
        - active
        - created
        - id
        - updated
    Application_ExtendedWorkflowSummary:
      type: object
      description: >-
        An entity for managing top-level application data. A application
        represents the highest level of organization for other entities within
        the application.
      properties:
        id:
          type: string
        active:
          type: boolean
        created:
          type: string
          format: date-time
        updated:
          type: string
          format: date-time
        name:
          type: string
          description: Name of the application.
        createdBy:
          $ref: '#/components/schemas/User_ExtendedWorkflowSummary'
          description: Creator of the application.
        description:
          type: string
          description: Description of the application.
          maxLength: 2000
          minLength: 0
        color:
          type: string
          description: Icon color of the application.
        icon:
          type: string
          description: Icon type of the application.
          enum:
            - >-
              fa-bookmark, fa-bolt, fa-bullhorn,
              fa-certificate,fa-check-square-o, fa-cloud, fa-comments,
              fa-dollar, fa-exclamation-triangle, fa-file-text-o,fa-folder,
              fa-gift, fa-globe, fa-heartbeat, fa-leaf, fa-legal, fa-life-ring,
              fa-medkit, fa-money,fa-percent, fa-rocket, fa-signal,
              fa-university, fa-user-circle
        type:
          type: string
        sourceApplicationId:
          type: string
        sourceEnvironment:
          type: string
        permissionsEnabled:
          type: boolean
        imported:
          type: boolean
        copied:
          type: boolean
        live:
          type: boolean
        currency:
          type: string
          enum:
            - EUR
            - GBP
            - USD
        uxriEnabled:
          type: boolean
          description: Whether or not UXRI is enabled on this application.
        shortCode:
          type: string
          description: Short display code for the application in navigation.
          pattern: ^(?! +$)[a-zA-Z0-9 ]{1,10}$
        defaultHomeScreen:
          $ref: '#/components/schemas/HomeScreen_ExtendedWorkflowSummary'
      required:
        - active
        - color
        - copied
        - created
        - createdBy
        - currency
        - defaultHomeScreen
        - description
        - icon
        - id
        - imported
        - live
        - name
        - permissionsEnabled
        - shortCode
        - sourceApplicationId
        - sourceEnvironment
        - type
        - updated
        - uxriEnabled
    UserGroup_ExtendedWorkflowSummary:
      type: object
      properties:
        id:
          type: string
        active:
          type: boolean
        created:
          type: string
          format: date-time
        updated:
          type: string
          format: date-time
        recordDefault:
          type: boolean
        title:
          type: string
        automatedUserGroup:
          type: boolean
        automatedUserGroupFieldLabel:
          type: string
      required:
        - active
        - automatedUserGroup
        - automatedUserGroupFieldLabel
        - created
        - id
        - recordDefault
        - title
        - updated
    PrimaryField_ExtendedWorkflowSummary:
      type: object
      properties:
        id:
          type: string
        active:
          type: boolean
        created:
          type: string
          format: date-time
        updated:
          type: string
          format: date-time
        field:
          $ref: '#/components/schemas/Field_ExtendedWorkflowSummary'
        systemField:
          type: string
          enum:
            - NAME
            - STATUS
            - CREATED
            - ENTERED_STEP_DATE
            - USER_DATE
            - EFFECTIVE_DUE_DATE
            - STEP_DUE_DATE
            - CURRENT_DATE
            - DUE_DATE
            - DAYS_UNTIL_DUE
            - SIMILARITY
            - RATIONALE
            - MATCH_CONFIDENCE
            - COMPLETED_DATE
            - LAST_COMPLETED_DATE
            - ID
            - SEQUENCE
            - ASSESSMENT_COUNT
            - USER_NAME
            - USER_ID
            - CREATOR_NAME
            - USER_GROUP
            - STEP_NAME
            - STEP_ID
            - ORIGIN_NAME
            - ORIGIN_ID
            - WORKFLOW_NAME
            - WORKFLOW_RECORD_PREFIX
            - WORKFLOW_ID
            - PRIMARY_FIELD
            - STATE
        name:
          type: string
      required:
        - active
        - created
        - field
        - id
        - name
        - systemField
        - updated
    CurrentValueUserGroupMapping_ExtendedWorkflowSummary:
      type: object
      properties:
        currentValue:
          $ref: '#/components/schemas/CurrentValue_ExtendedWorkflowSummary'
        userGroup:
          $ref: '#/components/schemas/UserGroup_ExtendedWorkflowSummary'
      required:
        - currentValue
        - userGroup
    Field_ExtendedWorkflowSummary:
      type: object
      description: >-
        An entity used to manage input fields used to capture record data for
        different workflows.
      discriminator:
        propertyName: fieldType
      oneOf:
        - $ref: '#/components/schemas/Text_ExtendedWorkflowSummary'
        - description: >-
            And other types: ExternalUser_ExtendedWorkflowSummary,
            ExternalId_ExtendedWorkflowSummary,
            TextArea_ExtendedWorkflowSummary,
            DatePicker_ExtendedWorkflowSummary, Number_ExtendedWorkflowSummary,
            ESignature_ExtendedWorkflowSummary,
            Checkbox_ExtendedWorkflowSummary,
            MultiSelect_ExtendedWorkflowSummary, Radio_ExtendedWorkflowSummary,
            Select_ExtendedWorkflowSummary, Attachment_ExtendedWorkflowSummary,
            User_ExtendedWorkflowSummary, Evidence_ExtendedWorkflowSummary,
            Calculation_ExtendedWorkflowSummary,
            FixedDateCalculation_ExtendedWorkflowSummary,
            LinkedRecordsCount_ExtendedWorkflowSummary,
            DueDate_ExtendedWorkflowSummary,
            TransientFieldDaysUntilDue_ExtendedWorkflowSummary,
            AnnualLossExposure_ExtendedWorkflowSummary,
            AecInfo_ExtendedWorkflowSummary, Text_ExtendedWorkflowSummary,
            ExternalUser_ExtendedWorkflowSummary,
            ExternalId_ExtendedWorkflowSummary,
            TextArea_ExtendedWorkflowSummary,
            DatePicker_ExtendedWorkflowSummary, Number_ExtendedWorkflowSummary,
            ESignature_ExtendedWorkflowSummary,
            Checkbox_ExtendedWorkflowSummary,
            MultiSelect_ExtendedWorkflowSummary, Radio_ExtendedWorkflowSummary,
            Select_ExtendedWorkflowSummary, Attachment_ExtendedWorkflowSummary,
            User_ExtendedWorkflowSummary, Evidence_ExtendedWorkflowSummary,
            Calculation_ExtendedWorkflowSummary,
            TextConcatenation_ExtendedWorkflowSummary,
            FixedDateCalculation_ExtendedWorkflowSummary,
            LinkedRecordsCount_ExtendedWorkflowSummary,
            DueDate_ExtendedWorkflowSummary,
            TransientFieldDaysUntilDue_ExtendedWorkflowSummary,
            AnnualLossExposure_ExtendedWorkflowSummary,
            AecInfo_ExtendedWorkflowSummary
      properties:
        id:
          type: string
        active:
          type: boolean
        created:
          type: string
          format: date-time
        updated:
          type: string
          format: date-time
        fieldType:
          type: string
          enum:
            - TEXT
            - EXTERNAL_USER
            - EXTERNAL_ID
            - TEXT_AREA
            - DATE_PICKER
            - NUMBER
            - E_SIGNATURE
            - CHECKBOX
            - MULTI_SELECT
            - RADIO
            - SELECT
            - USER
            - ATTACHMENT
            - CALCULATION
            - TEXT_CONCATENATION
            - FIXED_DATE_CALCULATION
            - LINKED_RECORDS_COUNT
            - DUE_DATE
            - DAYS_UNTIL_DUE
            - EVIDENCE
            - AEC_INFO
            - ANNUAL_LOSS_EXPOSURE
        name:
          type: string
          description: The name of the field.
        copyRecordAccessField:
          type: boolean
        currencyForNumberDisplayingFields:
          description: Circular reference to Field_ExtendedWorkflowSummary
          writeOnly: true
        requiresUniqueValue:
          type: boolean
        parameterizedCurrentValues:
          type: array
          items:
            $ref: '#/components/schemas/CurrentValueObject_ExtendedWorkflowSummary'
          writeOnly: true
        analysisOutputField:
          type: boolean
        currentValuesFromOtherField:
          description: Circular reference to Field_ExtendedWorkflowSummary
          writeOnly: true
        formatForNumberDisplayingFields:
          description: Circular reference to Field_ExtendedWorkflowSummary
          writeOnly: true
        crossWorkflowCalculation:
          type: boolean
        validTypeForCalculationInput:
          type: boolean
      required:
        - active
        - copyRecordAccessField
        - created
        - fieldType
        - id
        - name
        - updated
    WorkflowSummaryField_ExtendedWorkflowSummary:
      type: object
      properties:
        workflow:
          description: Circular reference to Workflow_ExtendedWorkflowSummary
          writeOnly: true
        field:
          $ref: '#/components/schemas/Field_ExtendedWorkflowSummary'
        priority:
          type: integer
          format: int32
        neo4jId:
          type: string
        fieldId:
          type: string
      required:
        - priority
    User_ExtendedWorkflowSummary:
      allOf:
        - $ref: '#/components/schemas/CurrentValue_ExtendedWorkflowSummary'
        - type: object
          properties:
            email:
              type: string
            status:
              type: string
            first:
              type: string
            last:
              type: string
      description: Entity for storing all information pertaining to a user.
      discriminator:
        propertyName: status
      oneOf:
        - description: Circular reference to Active_ExtendedWorkflowSummary
        - description: >-
            And other types: Automated_ExtendedWorkflowSummary,
            Disabled_ExtendedWorkflowSummary, External_ExtendedWorkflowSummary,
            Locked_ExtendedWorkflowSummary, Service_ExtendedWorkflowSummary
      properties:
        status:
          type: string
      required:
        - status
    HomeScreen_ExtendedWorkflowSummary:
      type: object
      properties:
        id:
          type: string
        active:
          type: boolean
        created:
          type: string
          format: date-time
        updated:
          type: string
          format: date-time
      required:
        - active
        - created
        - id
        - updated
    CurrentValue_ExtendedWorkflowSummary:
      type: object
      description: Entity used to manage record's field data.
      discriminator:
        propertyName: discriminator
      oneOf:
        - $ref: '#/components/schemas/CurrentCommonValue_ExtendedWorkflowSummary'
        - description: >-
            And other types: CurrentDateValue_ExtendedWorkflowSummary,
            CurrentDateRangeValue_ExtendedWorkflowSummary,
            CurrentJobValue_ExtendedWorkflowSummary,
            CurrentCommonValue_ExtendedWorkflowSummary,
            CurrentDateValue_ExtendedWorkflowSummary,
            CurrentDateRangeValue_ExtendedWorkflowSummary,
            LabelValue_ExtendedWorkflowSummary,
            CleanAttachment_ExtendedWorkflowSummary,
            DirtyAttachment_ExtendedWorkflowSummary,
            PendingAttachment_ExtendedWorkflowSummary,
            CurrentGoogleAttachmentValue_ExtendedWorkflowSummary,
            CurrentSharepointAttachmentValue_ExtendedWorkflowSummary,
            Active_ExtendedWorkflowSummary, Automated_ExtendedWorkflowSummary,
            Disabled_ExtendedWorkflowSummary, External_ExtendedWorkflowSummary,
            Locked_ExtendedWorkflowSummary, Service_ExtendedWorkflowSummary,
            CurrentNumericRangeValue_ExtendedWorkflowSummary,
            CurrentJobValue_ExtendedWorkflowSummary
      properties:
        id:
          type: string
        active:
          type: boolean
        created:
          type: string
          format: date-time
        updated:
          type: string
          format: date-time
        discriminator:
          type: string
        idOrTransientId:
          type: string
        transientIdOrId:
          type: string
        textOrNumericValue:
          type: string
        empty:
          type: boolean
      required:
        - active
        - created
        - discriminator
        - id
        - updated
    Text_ExtendedWorkflowSummary:
      allOf:
        - description: Circular reference to Field_ExtendedWorkflowSummary
      required:
        - fieldType
    CurrentValueObject_ExtendedWorkflowSummary:
      type: object
      description: Entity used to manage record's field data.
      discriminator:
        propertyName: discriminator
      oneOf:
        - $ref: '#/components/schemas/CurrentCommonValue_ExtendedWorkflowSummary'
        - description: >-
            And other types: CurrentDateValue_ExtendedWorkflowSummary,
            CurrentDateRangeValue_ExtendedWorkflowSummary,
            CurrentJobValue_ExtendedWorkflowSummary,
            CurrentCommonValue_ExtendedWorkflowSummary,
            CurrentDateValue_ExtendedWorkflowSummary,
            CurrentDateRangeValue_ExtendedWorkflowSummary,
            LabelValue_ExtendedWorkflowSummary,
            CleanAttachment_ExtendedWorkflowSummary,
            DirtyAttachment_ExtendedWorkflowSummary,
            PendingAttachment_ExtendedWorkflowSummary,
            CurrentGoogleAttachmentValue_ExtendedWorkflowSummary,
            CurrentSharepointAttachmentValue_ExtendedWorkflowSummary,
            Active_ExtendedWorkflowSummary, Automated_ExtendedWorkflowSummary,
            Disabled_ExtendedWorkflowSummary, External_ExtendedWorkflowSummary,
            Locked_ExtendedWorkflowSummary, Service_ExtendedWorkflowSummary,
            CurrentNumericRangeValue_ExtendedWorkflowSummary,
            CurrentJobValue_ExtendedWorkflowSummary
      properties:
        id:
          type: string
        active:
          type: boolean
        created:
          type: string
          format: date-time
        updated:
          type: string
          format: date-time
        discriminator:
          type: string
        idOrTransientId:
          type: string
        transientIdOrId:
          type: string
        textOrNumericValue:
          type: string
        empty:
          type: boolean
      required:
        - active
        - created
        - discriminator
        - id
        - updated
    CurrentCommonValue_ExtendedWorkflowSummary:
      allOf:
        - description: Circular reference to CurrentValue_ExtendedWorkflowSummary
      required:
        - description
  securitySchemes:
    ApiToken:
      type: http
      scheme: bearer
      bearerFormat: API Token
    basic:
      type: http
      scheme: basic

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.