---
updatedAt: 2026-04-21T14:40:57.000Z
agentTools:
  projectIndex: https://developer.zylo.com/llms.txt
---

# Get Workflow by ID

### Required Permissions
`applications:read AND integrations:read AND team:read`
### Rate Limit
`basic`

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "components": {
    "schemas": {
      "UUID": {
        "type": "string",
        "example": "52907745-7672-470e-a803-a2f8feb52944",
        "description": "Stringified UUIDv4.",
        "pattern": "[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-4[0-9A-Fa-f]{3}-[89ABab][0-9A-Fa-f]{3}-[0-9A-Fa-f]{12}"
      },
      "DateTime": {
        "type": "string",
        "format": "date-time",
        "description": "Diplays dates as a string in the format \"YYYY-MM-DD HH:MM:SS\"."
      },
      "Workflows": {
        "properties": {
          "application_id": {
            "allOf": [
              {
                "$ref": "#/components/schemas/UUID"
              }
            ],
            "nullable": true,
            "description": "Unique identifier for the application associated with the workflow."
          },
          "current_step": {
            "type": "string",
            "enum": [
              "Review Users",
              "Send Email",
              "Review Responses",
              "Deprovision & Notify",
              "Complete Workflow"
            ],
            "description": "The current step of the workflow."
          },
          "current_step_index": {
            "type": "number",
            "format": "double",
            "nullable": true,
            "description": "The current step index of the workflow."
          },
          "id": {
            "$ref": "#/components/schemas/UUID",
            "description": "Unique identifier for a workflow."
          },
          "last_day_to_respond": {
            "type": "string",
            "nullable": true,
            "description": "The last day to respond to the workflow."
          },
          "name": {
            "type": "string",
            "nullable": true,
            "description": "The name of the workflow."
          },
          "status": {
            "type": "string",
            "enum": [
              "Action Needed",
              "In Progress",
              "Not Started",
              "Complete",
              "Errored",
              "Skipped"
            ],
            "description": "The status of the workflow."
          },
          "total_step_count": {
            "type": "number",
            "format": "double",
            "nullable": true,
            "description": "The total step count of the workflow."
          },
          "users_actioned": {
            "type": "number",
            "format": "double",
            "nullable": true,
            "description": "The number of users who have taken action on the workflow."
          },
          "users_qualified": {
            "type": "number",
            "format": "double",
            "nullable": true,
            "description": "The number of users who have met the criteria for the workflow."
          },
          "users_responded": {
            "type": "string",
            "nullable": true,
            "description": "The number of users who have responded to the workflow."
          },
          "zylo_created_at": {
            "allOf": [
              {
                "$ref": "#/components/schemas/DateTime"
              }
            ],
            "nullable": true,
            "description": "Date and time the record was created in Zylo."
          },
          "zylo_modified_at": {
            "allOf": [
              {
                "$ref": "#/components/schemas/DateTime"
              }
            ],
            "nullable": true,
            "description": "Date and time the record was last modified in Zylo. Uses the created date by default."
          }
        },
        "required": [
          "application_id",
          "current_step",
          "current_step_index",
          "id",
          "last_day_to_respond",
          "name",
          "status",
          "total_step_count",
          "users_actioned",
          "users_qualified",
          "users_responded",
          "zylo_created_at",
          "zylo_modified_at"
        ],
        "type": "object",
        "additionalProperties": true
      }
    },
    "securitySchemes": {
      "apiKey": {
        "type": "http",
        "scheme": "bearer"
      }
    }
  },
  "info": {
    "title": "Resources",
    "version": "2.0.0"
  },
  "paths": {
    "/v2/workflows/{workflowId}": {
      "get": {
        "operationId": "WorkflowsController_GetWorkflowById",
        "responses": {
          "200": {
            "description": "Ok",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Workflows"
                }
              }
            }
          }
        },
        "description": "### Required Permissions\n`applications:read AND integrations:read AND team:read`\n### Rate Limit\n`basic`",
        "summary": "Get Workflow by ID",
        "tags": [
          "Workflows"
        ],
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "workflowId",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/UUID"
            }
          }
        ],
        "x-proxy-enabled": false
      }
    }
  },
  "servers": [
    {
      "url": "https://api.zylo.com/"
    }
  ],
  "tags": [
    {
      "name": "Workflows"
    }
  ]
}
```