---
id: workflows-get
sidebar_label: Returns all Workflow resources.
hide_title: true
hide_table_of_contents: true
api: {"operationId":"WorkflowsGet","tags":["Workflows"],"description":"This endpoint returns all Workflow resources. <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 />\nThe schema related to Workflow is: <br /> \n- **urn:ietf:params:scim:schemas:sailpoint:1.0:Workflow**\n","parameters":[{"in":"query","name":"filter","schema":{"type":"string","example":"name eq \"Do Provisioning Forms\""},"description":"Allows for query filters according to RFC-7644, Section 3.4.2.2 - not all operations are supported."},{"in":"query","name":"lookupByName","schema":{"type":"boolean","default":false,"example":true},"description":"**(OPTIONAL)** Set to true if the Workflows name is passed instead of the Workflow id."},{"in":"query","name":"sortBy","schema":{"type":"string","example":"name"},"description":"Allows sorting the results by a resource's attributes."},{"in":"query","name":"sortOrder","schema":{"type":"string","default":"ascending","example":"descending"},"description":"Determines what order to sort results in."},{"in":"query","name":"startIndex","schema":{"type":"integer","example":15,"default":1},"description":"Determines the starting index of the result set."},{"in":"query","name":"count","schema":{"type":"integer","example":15,"default":1000},"description":"Specifies the number of results per page."},{"in":"query","name":"attributes","schema":{"type":"string","example":"name"},"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, type"},"description":"A comma-separated list of attributes to exclude from the response. **Some attributes cannot be excluded.**"}],"responses":{"200":{"description":"Returned all SCIM resources for this endpoint.","content":{"application/json":{"schema":{"properties":{"totalResults":{"description":"Number of resources returned for this endpoint.","type":"integer","example":"1,"},"startIndex":{"description":"The starting index of the resource set list. Can be specified with startIndex query parameter.","type":"integer","example":1},"schemas":{"description":"SCIM Schema used for response.","type":"array","items":{"type":"string"},"example":["urn:ietf:params:scim:api:messages:2.0:ListResponse"]},"Resources":{"type":"array","items":{"required":["name"],"properties":{"id":{"description":"Unique identifier of the Workflow.","type":"string","example":"7f00000180281df7818028bf977502f3"},"name":{"description":"Name of the Workflow.","type":"string","example":"Identity Request Approve Identity Changes"},"description":{"description":"Description of the Workflow.","type":"string","example":"\n     The subprocess that drives the Create and Update Identity workflows.\n     This is different then the Identity Request Approve subprocess because this\n     approval process produces a form with the approval so that\n     approvers can update values while approving.\n\n     This subprocess builds the form necessary for the editable approvals\n     and then assimilates that data entered back to the plan, which\n     can be returned from the subprocess.\n"},"type":{"description":"Type of the Workflow.","type":"string","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":"Subprocess"},"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","example":"2022-04-14T10:44:46.453-05:00"},"location":{"description":"URL to the Workflow.","type":"string","example":"http://localhost:8080/identityiq/scim/v2/Workflows/7f00000180281df7818028bf977502f3"},"lastModified":{"description":"DateTime of Workflow last modification.","type":"string","example":"2022-05-05T15:52:30.119-05:00"},"version":{"description":"Workflow version.","type":"string","example":"W\"1649951086453\""},"resourceType":{"description":"Resource type of the metadata subject.","type":"string","example":"Workflow"}}}}}}}}},"application/scim+json":{"schema":{"properties":{"totalResults":{"description":"Number of Workflow resources returned.","type":"integer","example":"1500,"},"startIndex":{"description":"The starting index of the resource set list. Can be specified with startIndex query parameter.","type":"integer","example":1},"schemas":{"description":"SCIM Schema used for response.","type":"array","items":{"type":"string"},"example":["urn:ietf:params:scim:api:messages:2.0:ListResponse"]},"Resources":{"description":"The SCIM resources returned for this endpoint.","type":"array","items":{"required":["name"],"properties":{"id":{"description":"Unique identifier of the Workflow.","type":"string","example":"7f00000180281df7818028bf977502f3"},"name":{"description":"Name of the Workflow.","type":"string","example":"Identity Request Approve Identity Changes"},"description":{"description":"Description of the Workflow.","type":"string","example":"\n     The subprocess that drives the Create and Update Identity workflows.\n     This is different then the Identity Request Approve subprocess because this\n     approval process produces a form with the approval so that\n     approvers can update values while approving.\n\n     This subprocess builds the form necessary for the editable approvals\n     and then assimilates that data entered back to the plan, which\n     can be returned from the subprocess.\n"},"type":{"description":"Type of the Workflow.","type":"string","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":"Subprocess"},"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","example":"2022-04-14T10:44:46.453-05:00"},"location":{"description":"URL to the Workflow.","type":"string","example":"http://localhost:8080/identityiq/scim/v2/Workflows/7f00000180281df7818028bf977502f3"},"lastModified":{"description":"DateTime of Workflow last modification.","type":"string","example":"2022-05-05T15:52:30.119-05:00"},"version":{"description":"Workflow version.","type":"string","example":"W\"1649951086453\""},"resourceType":{"description":"Resource type of the metadata subject.","type":"string","example":"Workflow"}}}}}}}}}}}},"method":"get","path":"/Workflows","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 all Workflow resources.","description":{"content":"This endpoint returns all Workflow resources. <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 />\nThe schema related to Workflow is: <br /> \n- **urn:ietf:params:scim:schemas:sailpoint:1.0:Workflow**\n","type":"text/plain"},"url":{"path":["Workflows"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Allows for query filters according to RFC-7644, Section 3.4.2.2 - not all operations are supported.","type":"text/plain"},"key":"filter","value":""},{"disabled":false,"description":{"content":"**(OPTIONAL)** Set to true if the Workflows name is passed instead of the Workflow id.","type":"text/plain"},"key":"lookupByName","value":""},{"disabled":false,"description":{"content":"Allows sorting the results by a resource's attributes.","type":"text/plain"},"key":"sortBy","value":""},{"disabled":false,"description":{"content":"Determines what order to sort results in.","type":"text/plain"},"key":"sortOrder","value":""},{"disabled":false,"description":{"content":"Determines the starting index of the result set.","type":"text/plain"},"key":"startIndex","value":""},{"disabled":false,"description":{"content":"Specifies the number of results per page.","type":"text/plain"},"key":"count","value":""},{"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":[]},"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 all Workflow resources.' (workflows-get)"
---

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 all Workflow resources.



This endpoint returns all Workflow resources. <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>Query Parameters</strong></summary><div><ul><ParamsItem className={"paramsItem"} param={{"in":"query","name":"filter","schema":{"type":"string","example":"name eq \"Do Provisioning Forms\""},"description":"Allows for query filters according to RFC-7644, Section 3.4.2.2 - not all operations are supported."}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"lookupByName","schema":{"type":"boolean","default":false,"example":true},"description":"**(OPTIONAL)** Set to true if the Workflows name is passed instead of the Workflow id."}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"sortBy","schema":{"type":"string","example":"name"},"description":"Allows sorting the results by a resource's attributes."}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"sortOrder","schema":{"type":"string","default":"ascending","example":"descending"},"description":"Determines what order to sort results in."}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"startIndex","schema":{"type":"integer","example":15,"default":1},"description":"Determines the starting index of the result set."}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"count","schema":{"type":"integer","example":15,"default":1000},"description":"Specifies the number of results per page."}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"attributes","schema":{"type":"string","example":"name"},"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, type"},"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>

Returned all SCIM resources for this endpoint.

</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={"totalResults"} required={false} deprecated={undefined} schemaDescription={"Number of resources returned for this endpoint."} schemaName={"integer"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"startIndex"} required={false} deprecated={undefined} schemaDescription={"The starting index of the resource set list. Can be specified with startIndex query parameter."} schemaName={"integer"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"schemas"} required={false} deprecated={undefined} schemaDescription={"SCIM Schema used for response."} schemaName={"string[]"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>Resources</strong><span style={{"opacity":"0.6"}}> undefined[]</span></summary><div 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={"string"} 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={"string"} 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></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"totalResults\": \"1,\",\n  \"startIndex\": 1,\n  \"schemas\": [\n    \"urn:ietf:params:scim:api:messages:2.0:ListResponse\"\n  ],\n  \"Resources\": [\n    {\n      \"id\": \"7f00000180281df7818028bf977502f3\",\n      \"name\": \"Identity Request Approve Identity Changes\",\n      \"description\": \"\\n     The subprocess that drives the Create and Update Identity workflows.\\n     This is different then the Identity Request Approve subprocess because this\\n     approval process produces a form with the approval so that\\n     approvers can update values while approving.\\n\\n     This subprocess builds the form necessary for the editable approvals\\n     and then assimilates that data entered back to the plan, which\\n     can be returned from the subprocess.\\n\",\n      \"type\": \"Subprocess\",\n      \"handler\": \"sailpoint.api.StandardWorkflowHandler\",\n      \"meta\": {\n        \"created\": \"2022-04-14T10:44:46.453-05:00\",\n        \"location\": \"http://localhost:8080/identityiq/scim/v2/Workflows/7f00000180281df7818028bf977502f3\",\n        \"lastModified\": \"2022-05-05T15:52:30.119-05:00\",\n        \"version\": \"W\\\"1649951086453\\\"\",\n        \"resourceType\": \"Workflow\"\n      }\n    }\n  ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem><TabItem label={"application/scim+json"} value={"application/scim+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={"totalResults"} required={false} deprecated={undefined} schemaDescription={"Number of Workflow resources returned."} schemaName={"integer"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"startIndex"} required={false} deprecated={undefined} schemaDescription={"The starting index of the resource set list. Can be specified with startIndex query parameter."} schemaName={"integer"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"schemas"} required={false} deprecated={undefined} schemaDescription={"SCIM Schema used for response."} schemaName={"string[]"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>Resources</strong><span style={{"opacity":"0.6"}}> undefined[]</span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The SCIM resources returned for this endpoint.

</div><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={"string"} 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={"string"} 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></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"totalResults\": \"1500,\",\n  \"startIndex\": 1,\n  \"schemas\": [\n    \"urn:ietf:params:scim:api:messages:2.0:ListResponse\"\n  ],\n  \"Resources\": [\n    {\n      \"id\": \"7f00000180281df7818028bf977502f3\",\n      \"name\": \"Identity Request Approve Identity Changes\",\n      \"description\": \"\\n     The subprocess that drives the Create and Update Identity workflows.\\n     This is different then the Identity Request Approve subprocess because this\\n     approval process produces a form with the approval so that\\n     approvers can update values while approving.\\n\\n     This subprocess builds the form necessary for the editable approvals\\n     and then assimilates that data entered back to the plan, which\\n     can be returned from the subprocess.\\n\",\n      \"type\": \"Subprocess\",\n      \"handler\": \"sailpoint.api.StandardWorkflowHandler\",\n      \"meta\": {\n        \"created\": \"2022-04-14T10:44:46.453-05:00\",\n        \"location\": \"http://localhost:8080/identityiq/scim/v2/Workflows/7f00000180281df7818028bf977502f3\",\n        \"lastModified\": \"2022-05-05T15:52:30.119-05:00\",\n        \"version\": \"W\\\"1649951086453\\\"\",\n        \"resourceType\": \"Workflow\"\n      }\n    }\n  ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div>