---
id: get-workflow-by-id
sidebar_label: Returns a Workflow resource based on id.
hide_title: true
hide_table_of_contents: true
api: {"operationId":"getWorkflowById","tags":["Workflows"],"description":"The Workflow resource with matching id is returned.<br /><br />\nAttributes to include in the response can be specified with the attributes query parameter. <br /><br /> \nAttributes to exclude from the response can be specified with the excludedAttributes query parameter. <br /><br />\n\nThe schema related to Workflow is: <br /> \n- **urn:ietf:params:scim:schemas:sailpoint:1.0:Workflow**\n","parameters":[{"name":"workflowId","in":"path","schema":{"type":"string","example":"c0a8019c802d1e5a81802eb2b57e020f"},"description":"id of Workflow resource.","required":true},{"in":"query","name":"attributes","schema":{"type":"string","example":"name, type"},"description":"A comma-separated list of attributes to return in the response. This query parameter supersedes excludedAttributes, so providing the same attribute(s) to both will result in the attribute(s) being returned."},{"in":"query","name":"excludedAttributes","schema":{"type":"string","example":"name, handler"},"description":"A comma-separated list of attributes to exclude from the response. **Some attributes cannot be excluded.**"}],"responses":{"200":{"description":"Returns a single Workflow resource based on the id.","content":{"application/json":{"schema":{"required":["name"],"properties":{"id":{"description":"Unique identifier of the Workflow.","type":"string","example":"7f00000180281df7818028be6a9c01a3"},"name":{"description":"Name of the Workflow.","type":"string","example":"Aggregate Correlated Applications"},"description":{"description":"Description of the Workflow.","type":"string","example":"Library for Steps."},"type":{"type":"string","description":"Type of the Workflow.","enum":["Batch Provisioning","Scheduled Assignment","Scheduled Role Activation","Managed Attribute","Identity Correlation","Identity Event","Identity Lifecycle","Identity Update","Identity Refresh","LCM Identity","LCM Provisioning","LCM Registration","Policy Violation","Role Modeler","Subprocess","Password Intercept","Alert","Attribute Sync"],"example":"Step Library"},"handler":{"description":"Handler of the Workflow.","type":"string","example":"sailpoint.api.StandardWorkflowHandler"},"meta":{"type":"object","properties":{"created":{"description":"DateTime when the Workflow was created.","type":"string","format":"date-time","example":"2022-04-14T10:43:29.436-05:00"},"location":{"description":"URL to the Workflow.","type":"string","example":"http://localhost:8080/identityiq/scim/v2/Workflows/7f00000180281df7818028be6a9c01a3"},"lastModified":{"description":"DateTime of Workflow last modification.","type":"string","format":"date-time","example":"2022-05-05T15:52:30.119-05:00"},"version":{"description":"Workflow version.","type":"string","example":"\"W\"1649951094834\""},"resourceType":{"description":"Resource type of the metadata subject.","type":"string","example":"Workflow"}}}}}}}}},"method":"get","path":"/Workflows/{workflowId}","servers":[{"url":"http://localhost:8080/identityiq/scim/v2","description":"IdentityIQ SCIM server basepath and path to API."}],"security":[{"basicAuth":[]}],"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"}},"info":{"description":"IdentityIQ REST Endpoint Interface Documentation for SCIM\n","version":"8.3","title":"IdentityIQ SCIM REST API"},"postman":{"name":"Returns a Workflow resource based on id.","description":{"content":"The Workflow resource with matching id is returned.<br /><br />\nAttributes to include in the response can be specified with the attributes query parameter. <br /><br /> \nAttributes to exclude from the response can be specified with the excludedAttributes query parameter. <br /><br />\n\nThe schema related to Workflow is: <br /> \n- **urn:ietf:params:scim:schemas:sailpoint:1.0:Workflow**\n","type":"text/plain"},"url":{"path":["Workflows",":workflowId"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"A comma-separated list of attributes to return in the response. This query parameter supersedes excludedAttributes, so providing the same attribute(s) to both will result in the attribute(s) being returned.","type":"text/plain"},"key":"attributes","value":""},{"disabled":false,"description":{"content":"A comma-separated list of attributes to exclude from the response. **Some attributes cannot be excluded.**","type":"text/plain"},"key":"excludedAttributes","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) id of Workflow resource.","type":"text/plain"},"type":"any","value":"","key":"workflowId"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}}
sidebar_class_name: "get api-method"
info_path: iiq/api/identityiq-scim-rest-api
custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Returns a Workflow resource based on id.' (get-workflow-by-id)"
---

import ApiTabs from "@theme/ApiTabs";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import TabItem from "@theme/TabItem";

## Returns a Workflow resource based on id.



The Workflow resource with matching id is returned.<br /><br />
Attributes to include in the response can be specified with the attributes query parameter. <br /><br /> 
Attributes to exclude from the response can be specified with the excludedAttributes query parameter. <br /><br />

The schema related to Workflow is: <br /> 
- **urn:ietf:params:scim:schemas:sailpoint:1.0:Workflow**


<details style={{"marginBottom":"1rem"}} data-collapsed={false} open={true}><summary style={{}}><strong>Path Parameters</strong></summary><div><ul><ParamsItem className={"paramsItem"} param={{"name":"workflowId","in":"path","schema":{"type":"string","example":"c0a8019c802d1e5a81802eb2b57e020f"},"description":"id of Workflow resource.","required":true}}></ParamsItem></ul></div></details><details style={{"marginBottom":"1rem"}} data-collapsed={false} open={true}><summary style={{}}><strong>Query Parameters</strong></summary><div><ul><ParamsItem className={"paramsItem"} param={{"in":"query","name":"attributes","schema":{"type":"string","example":"name, type"},"description":"A comma-separated list of attributes to return in the response. This query parameter supersedes excludedAttributes, so providing the same attribute(s) to both will result in the attribute(s) being returned."}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"excludedAttributes","schema":{"type":"string","example":"name, handler"},"description":"A comma-separated list of attributes to exclude from the response. **Some attributes cannot be excluded.**"}}></ParamsItem></ul></div></details><div><ApiTabs><TabItem label={"200"} value={"200"}><div>

Returns a single Workflow resource based on the id.

</div><div><MimeTabs schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs><TabItem label={"Schema"} value={"Schema"}><details style={{}} data-collapsed={false} open={true}><summary style={{"textAlign":"left"}}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={false} deprecated={undefined} schemaDescription={"Unique identifier of the Workflow."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} deprecated={undefined} schemaDescription={"Name of the Workflow."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} deprecated={undefined} schemaDescription={"Description of the Workflow."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} deprecated={undefined} schemaDescription={"Type of the Workflow."} schemaName={"string"} qualifierMessage={"**Possible values:** [`Batch Provisioning`, `Scheduled Assignment`, `Scheduled Role Activation`, `Managed Attribute`, `Identity Correlation`, `Identity Event`, `Identity Lifecycle`, `Identity Update`, `Identity Refresh`, `LCM Identity`, `LCM Provisioning`, `LCM Registration`, `Policy Violation`, `Role Modeler`, `Subprocess`, `Password Intercept`, `Alert`, `Attribute Sync`]"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"handler"} required={false} deprecated={undefined} schemaDescription={"Handler of the Workflow."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>meta</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"created"} required={false} deprecated={undefined} schemaDescription={"DateTime when the Workflow was created."} schemaName={"date-time"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"location"} required={false} deprecated={undefined} schemaDescription={"URL to the Workflow."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"lastModified"} required={false} deprecated={undefined} schemaDescription={"DateTime of Workflow last modification."} schemaName={"date-time"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"version"} required={false} deprecated={undefined} schemaDescription={"Workflow version."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"resourceType"} required={false} deprecated={undefined} schemaDescription={"Resource type of the metadata subject."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"id\": \"7f00000180281df7818028be6a9c01a3\",\n  \"name\": \"Aggregate Correlated Applications\",\n  \"description\": \"Library for Steps.\",\n  \"type\": \"Step Library\",\n  \"handler\": \"sailpoint.api.StandardWorkflowHandler\",\n  \"meta\": {\n    \"created\": \"2022-04-14T10:43:29.436-05:00\",\n    \"location\": \"http://localhost:8080/identityiq/scim/v2/Workflows/7f00000180281df7818028be6a9c01a3\",\n    \"lastModified\": \"2022-05-05T15:52:30.119-05:00\",\n    \"version\": \"\\\"W\\\"1649951094834\\\"\",\n    \"resourceType\": \"Workflow\"\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div>