--- title: List of workflow instances --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/go) [Workflows](https://developers.cloudflare.com/api/go/resources/workflows) [Instances](https://developers.cloudflare.com/api/go/resources/workflows/subresources/instances) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # List of workflow instances client.Workflows.Instances.List(ctx, workflowName, params) (\*V4PagePaginationArray\[[InstanceListResponse]()], error) GET/accounts/{account\_id}/workflows/{workflow\_name}/instances Lists all instances of a workflow with their execution status. ##### Security
API Token The preferred authorization scheme for interacting with the Cloudflare API. Create a token. **Example:**Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY
API Email + API Key The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key. **Example:**X-Auth-Email: user@example.com The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys. **Example:**X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194
##### Accepted Permissions (at least one required) `Workers Tail Read``Workers Scripts Write``Workers Scripts Read` ##### ParametersExpand Collapse workflowName string maxLength64 minLength1 [Link to this property](<#(resource)%20workflows.instances%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20workflow_name%20%3E%20(schema)>)
params InstanceListParams AccountID param.Field\[string] Path param Link to this property Cursor param.Field\[string]Optional Query param: Opaque token for cursor-based pagination. Mutually exclusive with page. Link to this property DateEnd param.Field\[Time]Optional Query param: Accepts ISO 8601 with no timezone offsets and in UTC. formatdate-time Link to this property DateStart param.Field\[Time]Optional Query param: Accepts ISO 8601 with no timezone offsets and in UTC. formatdate-time Link to this property
Direction param.Field\[InstanceListParamsDirection]Optional Query param: Defines the direction for cursor-based pagination. const InstanceListParamsDirectionAsc InstanceListParamsDirection = "asc" Link to this property const InstanceListParamsDirectionDesc InstanceListParamsDirection = "desc" Link to this property
Link to this property DeprecatedPage param.Field\[float64]Optional Query param: Deprecated: use cursor for pagination instead. minimum1 Link to this property PerPage param.Field\[float64]Optional Query param maximum100 minimum1 Link to this property
Status param.Field\[InstanceListParamsStatus]Optional Query param const InstanceListParamsStatusQueued InstanceListParamsStatus = "queued" Link to this property const InstanceListParamsStatusRunning InstanceListParamsStatus = "running" Link to this property const InstanceListParamsStatusPaused InstanceListParamsStatus = "paused" Link to this property const InstanceListParamsStatusErrored InstanceListParamsStatus = "errored" Link to this property const InstanceListParamsStatusTerminated InstanceListParamsStatus = "terminated" Link to this property const InstanceListParamsStatusComplete InstanceListParamsStatus = "complete" Link to this property const InstanceListParamsStatusWaitingForPause InstanceListParamsStatus = "waitingForPause" Link to this property const InstanceListParamsStatusWaiting InstanceListParamsStatus = "waiting" Link to this property const InstanceListParamsStatusRollingBack InstanceListParamsStatus = "rollingBack" Link to this property
Link to this property
[Link to this property](<#(resource)%20workflows.instances%20%3E%20(method)%20list%20%3E%20(params)%20default>) ##### ReturnsExpand Collapse
type InstanceListResponse struct{…} ID string maxLength100 minLength1 Link to this property CreatedOn Time formatdate-time Link to this property EndedOn Time formatdate-time Link to this property ModifiedOn Time formatdate-time Link to this property StartedOn Time formatdate-time Link to this property
Status InstanceListResponseStatus One of the following: const InstanceListResponseStatusQueued InstanceListResponseStatus = "queued" Link to this property const InstanceListResponseStatusRunning InstanceListResponseStatus = "running" Link to this property const InstanceListResponseStatusPaused InstanceListResponseStatus = "paused" Link to this property const InstanceListResponseStatusErrored InstanceListResponseStatus = "errored" Link to this property const InstanceListResponseStatusTerminated InstanceListResponseStatus = "terminated" Link to this property const InstanceListResponseStatusComplete InstanceListResponseStatus = "complete" Link to this property const InstanceListResponseStatusWaitingForPause InstanceListResponseStatus = "waitingForPause" Link to this property const InstanceListResponseStatusWaiting InstanceListResponseStatus = "waiting" Link to this property const InstanceListResponseStatusRollingBack InstanceListResponseStatus = "rollingBack" Link to this property
Link to this property VersionID string formatuuid Link to this property WorkflowID string formatuuid Link to this property
TriggerSource InstanceListResponseTriggerSourceOptional One of the following: const InstanceListResponseTriggerSourceUnknown InstanceListResponseTriggerSource = "unknown" Link to this property const InstanceListResponseTriggerSourceAPI InstanceListResponseTriggerSource = "api" Link to this property const InstanceListResponseTriggerSourceBinding InstanceListResponseTriggerSource = "binding" Link to this property const InstanceListResponseTriggerSourceEvent InstanceListResponseTriggerSource = "event" Link to this property const InstanceListResponseTriggerSourceCron InstanceListResponseTriggerSource = "cron" Link to this property
Link to this property
[Link to this property](<#(resource)%20workflows.instances%20%3E%20(model)%20InstanceListResponse%20%3E%20(schema)>) ### List of workflow instances Go HTTPTypeScriptPythonGoTerraform ``` package main import ( "context" "fmt" "github.com/cloudflare/cloudflare-go" "github.com/cloudflare/cloudflare-go/option" "github.com/cloudflare/cloudflare-go/workflows" ) func main() { client := cloudflare.NewClient( option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"), ) page, err := client.Workflows.Instances.List( context.TODO(), "x", workflows.InstanceListParams{ AccountID: cloudflare.F("account_id"), }, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", page) } ``` 200 example ``` { "errors": [], "messages": [ { "code": 0, "message": "message" } ], "result": [ { "id": "x", "created_on": "2019-12-27T18:11:19.117Z", "ended_on": "2019-12-27T18:11:19.117Z", "modified_on": "2019-12-27T18:11:19.117Z", "started_on": "2019-12-27T18:11:19.117Z", "status": "queued", "version_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "workflow_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "trigger_source": "unknown" } ], "success": true, "result_info": { "count": 0, "per_page": 0, "total_count": 0, "cursor": "cursor", "page": 0, "total_pages": 0 } } ``` ##### Returns Examples 200 example ``` { "errors": [], "messages": [ { "code": 0, "message": "message" } ], "result": [ { "id": "x", "created_on": "2019-12-27T18:11:19.117Z", "ended_on": "2019-12-27T18:11:19.117Z", "modified_on": "2019-12-27T18:11:19.117Z", "started_on": "2019-12-27T18:11:19.117Z", "status": "queued", "version_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "workflow_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "trigger_source": "unknown" } ], "success": true, "result_info": { "count": 0, "per_page": 0, "total_count": 0, "cursor": "cursor", "page": 0, "total_pages": 0 } } ```