--- title: Get Workflow details --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/typescript) [Workflows](https://developers.cloudflare.com/api/typescript/resources/workflows) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Get Workflow details client.workflows.get(stringworkflowName, WorkflowGetParams {account\_id } params, RequestOptionsoptions?): [WorkflowGetResponse]() {id, class\_name, created\_on, 7 more } GET/accounts/{account\_id}/workflows/{workflow\_name} Retrieves configuration and metadata for a specific workflow. ##### 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%20%3E%20(method)%20get%20%3E%20(params)%20default%20%3E%20(param)%20workflow_name%20%3E%20(schema)>)
params: WorkflowGetParams {account\_id } account\_id: string Link to this property
[Link to this property](<#(resource)%20workflows%20%3E%20(method)%20get%20%3E%20(params)%20default>) ##### ReturnsExpand Collapse
WorkflowGetResponse {id, class\_name, created\_on, 7 more } id: string formatuuid Link to this property class\_name: string Link to this property created\_on: string formatdate-time Link to this property instances: Record<string, number> Link to this property modified\_on: string formatdate-time Link to this property name: string maxLength64 minLength1 Link to this property script\_name: string Link to this property triggered\_on: string| null formatdate-time Link to this property
schedules?: Array<Schedule> cron: string Link to this property next\_instance: string Link to this property
Link to this property script\_deleted?: boolean Whether the bound Worker was deleted, leaving this Workflow inactive. Link to this property
[Link to this property](<#(resource)%20workflows%20%3E%20(model)%20workflow_get_response%20%3E%20(schema)>) ### Get Workflow details TypeScript HTTPTypeScriptPythonGoTerraform ``` import Cloudflare from 'cloudflare'; const client = new Cloudflare({ apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted }); const workflow = await client.workflows.get('x', { account_id: 'account_id' }); console.log(workflow.id); ``` 200 example ``` { "errors": [], "messages": [ { "code": 0, "message": "message" } ], "result": { "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "class_name": "class_name", "created_on": "2019-12-27T18:11:19.117Z", "instances": { "foo": 0 }, "modified_on": "2019-12-27T18:11:19.117Z", "name": "x", "script_name": "script_name", "triggered_on": "2019-12-27T18:11:19.117Z", "schedules": [ { "cron": "cron", "next_instance": "next_instance" } ], "script_deleted": true }, "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": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "class_name": "class_name", "created_on": "2019-12-27T18:11:19.117Z", "instances": { "foo": 0 }, "modified_on": "2019-12-27T18:11:19.117Z", "name": "x", "script_name": "script_name", "triggered_on": "2019-12-27T18:11:19.117Z", "schedules": [ { "cron": "cron", "next_instance": "next_instance" } ], "script_deleted": true }, "success": true, "result_info": { "count": 0, "per_page": 0, "total_count": 0, "cursor": "cursor", "page": 0, "total_pages": 0 } } ```