---
id: get-workflow-sessions
sidebar_label: Get workflow sessions
hide_title: true
hide_table_of_contents: true
api: {"operationId":"getWorkflowSessions","description":"Get workflow sessions","tags":["Workflow Sessions"],"parameters":[{"name":"query","in":"query","description":"Allows for pagination and sorting using the deepObject notation.\n\n</br>\n\n`resource?query[limit]=50&query[offset]=0&query[order]=label`\n\n</br>\n\n<table><thead>\n<tr>\n<th>Parameter</th>\n<th>Description</th>\n<th>Default</th>\n</tr>\n</thead><tbody>\n<tr>\n<td>limit</td>\n<td>Limits the number of results returned</td>\n<td>100</td>\n</tr>\n<tr>\n<td>offset</td>\n<td>Returns the results starting at the value provided</td>\n<td>0</td>\n</tr>\n<tr>\n<td>order</td>\n<td>Allows you to determine the order in which the data is returned (not available on profile attributes)</td>\n<td>id</td>\n</tr>\n</tbody></table>\n","required":false,"schema":{"type":"object","properties":{"limit":{"type":"integer","description":"The limit of results to return","example":100},"offset":{"type":"integer","description":"The number of records to offset","example":50},"order":{"type":"string","description":"The attribute to order by","example":"created_at"}}},"style":"deepObject","explode":true,"example":"query[limit]=100&query[offset]=50&query[order]=created_at"},{"name":"profile_id","in":"query","description":"Profile ID to filter by","required":false,"schema":{"type":"string","format":"uuid"},"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},{"name":"uid","in":"query","description":"Workflow session uid for filtering","required":false,"schema":{"type":"string","minLength":32,"maxLength":32},"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},{"name":"workflow_id","in":"query","description":"Workflow ID for filtering","required":false,"schema":{"type":"string","format":"uuid"},"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},{"name":"requester_id","in":"query","description":"Requester ID for filtering","required":false,"schema":{"type":"string","format":"uuid"},"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},{"name":"status","in":"query","description":"filter by workflow session status","required":false,"schema":{"type":"string","enum":["waiting on workflow","identity proofing completed","new","closing","pending request","requested","pending approval","approved","pending notification","notified","pending review","reviewed","pending trigger","stored procedure","pending status change","status changed","pending update","non employee updated","non employee created","pending creation","rejected","pending assignment","assigned","default","failed","un assigned","auto assigned","ldap provided","pending ldap","pending fulfillment","pending stored procedure","pending courion add","fulfilled","pending courion update","courion add","pending courion_extend","courion update","pending courion terminate","courion extend","pending profile select","courion terminate","batch completed","profiles selected","answered questions","pending questions","attempting to start workflow","started workflow","profile check complete","completed","processing","pending set attribute","invitation sent","action skipped","api request sent","attribute set","disabled","duplicates resolved","soap request sent","checking for duplicates","pending identity proofing","closed","workflow changed"]},"example":"batch completed"},{"name":"metadata","in":"query","description":"Returns batching metadata in the response","required":false,"example":true,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Expected response to a valid request","content":{"application/json":{"schema":{"type":"object","properties":{"workflow_sessions":{"type":"array","items":{"type":"object","properties":{"id":{"description":"The id","type":"string","format":"uuid","readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"uid":{"description":"The uid","type":"string","minLength":32,"maxLength":32,"readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"workflow_id":{"description":"The workflow id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"requester_id":{"description":"the requester id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"requester_type":{"description":"The requester type","type":"string","enum":["User","NeprofileUser","NeaccessUser"],"example":"User"},"profile_id":{"type":"string","format":"uuid","description":"The profile this workflow session will be working with. Only Applicable for Update workflows","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"profile_ids":{"type":"array","items":{"type":"string","format":"uuid"},"description":"The profiles this workflow session will be working with. Only Applicable for Batch workflows","example":["db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","db6f8e8b-65c2-47d5-a0db-90bcc4e9df9t"]},"status":{"description":"The status","type":"string","enum":["api_request_sent","approved","assigned","attempting_to_start_workflow","AUTH-STATUS1","AUTH-STATUS2","AUTH-STATUS3","AUTH-STATUS4","AUTH-STATUS5","AUTH-STATUS6","AUTH-STATUS7","AUTH-STATUS8","AUTH-STATUS9","auto_assigned","batch_completed","checking_for_duplicates","closed","completed","courion_add","courion_extend","courion_terminate","courion_update","duplicates_resolved","failed","fulfilled","invitation_sent","ldap_provided","new","non_employee_created","non_employee_updated","notified","pending_approval","pending_assignment","pending_courion_add","pending_courion_extend","pending_courion_terminate","pending_courion_update","pending_creation","pending_fulfillment","pending_ldap","pending_notification","pending_profile_select","pending_request","pending_review","pending_status_change","pending_stored_procedure","pending_trigger","pending_update","processing","profile_check_complete","profiles_selected","rejected","requested","reviewed","soap_request_sent","started_workflow","status_changed","stored_procedure","un_assigned","waiting_on_workflow","workflow_changed"],"example":"completed"},"attributes":{"description":"The attributes","type":"object","additionalProperties":{"type":"string"},"example":{"text_attribute_uid":"static text","date_attribute_uid":"01/15/2020","profile_select_attribute_uid":"Profile Name","multiple_profile_select_attribute_uid":"Profile Name,Second Profile Name,Third Profile Name","contributor_select_attribute_uid":"User Name","multiple_contributor_select_attribute_uid":"User Name,Second User Name,Third User Name"}}}}},"_metadata":{"type":"object","properties":{"limit":{"description":"The limit","type":"integer","format":"int32","example":50},"offset":{"description":"The offset","type":"integer","format":"int32","example":100},"total":{"description":"The total","type":"integer","format":"int32","example":10000},"next":{"description":"The link to the next page of data","type":"string","example":"/endpoint?limit=10&offset=60"},"previous":{"description":"The link to the previous page of data","type":"string","example":"/endpoint?limit=10&offset=40"}}}}}}}},"400":{"description":"Bad Request - unable to complete.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"error":{"example":"Invalid JSON syntax. Please check your syntax and try again."}}},{"type":"object","properties":{"error":{"example":"The <object> failed to create/update"},"errors":{"example":{"attribute":"can't be blank"}}}}]}}}},"500":{"description":"Internal Server Error - returned on unhandled exceptions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"Sorry something went wrong"}}}}}}},"method":"get","path":"/workflow_sessions","info":{"version":"1.0.0","title":"NERM Lifecycle API","description":"The Lifecycle API can be used to access and modify various resources in your environment.","license":{"name":"MIT"}},"postman":{"name":"Get workflow sessions","description":{"content":"Get workflow sessions","type":"text/plain"},"url":{"path":["workflow_sessions"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Profile ID to filter by","type":"text/plain"},"key":"profile_id","value":""},{"disabled":false,"description":{"content":"Workflow session uid for filtering","type":"text/plain"},"key":"uid","value":""},{"disabled":false,"description":{"content":"Workflow ID for filtering","type":"text/plain"},"key":"workflow_id","value":""},{"disabled":false,"description":{"content":"Requester ID for filtering","type":"text/plain"},"key":"requester_id","value":""},{"disabled":false,"description":{"content":"filter by workflow session status","type":"text/plain"},"key":"status","value":""},{"disabled":false,"description":{"content":"Returns batching metadata in the response","type":"text/plain"},"key":"metadata","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}}
sidebar_class_name: "get api-method"
info_path: nerm/api/nerm-lifecycle-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 'Get workflow sessions' (get-workflow-sessions)"
---

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";

## Get workflow sessions



Get workflow sessions

<details style={{"marginBottom":"1rem"}} data-collapsed={false} open={true}><summary style={{}}><strong>Query Parameters</strong></summary><div><ul><ParamsItem className={"paramsItem"} param={{"name":"query","in":"query","description":"Allows for pagination and sorting using the deepObject notation.\n\n</br>\n\n`resource?query[limit]=50&query[offset]=0&query[order]=label`\n\n</br>\n\n<table><thead>\n<tr>\n<th>Parameter</th>\n<th>Description</th>\n<th>Default</th>\n</tr>\n</thead><tbody>\n<tr>\n<td>limit</td>\n<td>Limits the number of results returned</td>\n<td>100</td>\n</tr>\n<tr>\n<td>offset</td>\n<td>Returns the results starting at the value provided</td>\n<td>0</td>\n</tr>\n<tr>\n<td>order</td>\n<td>Allows you to determine the order in which the data is returned (not available on profile attributes)</td>\n<td>id</td>\n</tr>\n</tbody></table>\n","required":false,"schema":{"type":"object","properties":{"limit":{"type":"integer","description":"The limit of results to return","example":100},"offset":{"type":"integer","description":"The number of records to offset","example":50},"order":{"type":"string","description":"The attribute to order by","example":"created_at"}}},"style":"deepObject","explode":true,"example":"query[limit]=100&query[offset]=50&query[order]=created_at"}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"profile_id","in":"query","description":"Profile ID to filter by","required":false,"schema":{"type":"string","format":"uuid"},"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"uid","in":"query","description":"Workflow session uid for filtering","required":false,"schema":{"type":"string","minLength":32,"maxLength":32},"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"workflow_id","in":"query","description":"Workflow ID for filtering","required":false,"schema":{"type":"string","format":"uuid"},"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"requester_id","in":"query","description":"Requester ID for filtering","required":false,"schema":{"type":"string","format":"uuid"},"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"status","in":"query","description":"filter by workflow session status","required":false,"schema":{"type":"string","enum":["waiting on workflow","identity proofing completed","new","closing","pending request","requested","pending approval","approved","pending notification","notified","pending review","reviewed","pending trigger","stored procedure","pending status change","status changed","pending update","non employee updated","non employee created","pending creation","rejected","pending assignment","assigned","default","failed","un assigned","auto assigned","ldap provided","pending ldap","pending fulfillment","pending stored procedure","pending courion add","fulfilled","pending courion update","courion add","pending courion_extend","courion update","pending courion terminate","courion extend","pending profile select","courion terminate","batch completed","profiles selected","answered questions","pending questions","attempting to start workflow","started workflow","profile check complete","completed","processing","pending set attribute","invitation sent","action skipped","api request sent","attribute set","disabled","duplicates resolved","soap request sent","checking for duplicates","pending identity proofing","closed","workflow changed"]},"example":"batch completed"}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"metadata","in":"query","description":"Returns batching metadata in the response","required":false,"example":true,"schema":{"type":"boolean","default":false}}}></ParamsItem></ul></div></details><div><ApiTabs><TabItem label={"200"} value={"200"}><div>

Expected response to a valid request

</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={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>workflow_sessions</strong><span style={{"opacity":"0.6"}}> object[]</span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={false} deprecated={undefined} schemaDescription={"The id"} schemaName={"uuid"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"uid"} required={false} deprecated={undefined} schemaDescription={"The uid"} schemaName={"string"} qualifierMessage={"**Possible values:** `>= 32 characters` and `<= 32 characters`"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"workflow_id"} required={false} deprecated={undefined} schemaDescription={"The workflow id"} schemaName={"uuid"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"requester_id"} required={false} deprecated={undefined} schemaDescription={"the requester id"} schemaName={"uuid"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"requester_type"} required={false} deprecated={undefined} schemaDescription={"The requester type"} schemaName={"string"} qualifierMessage={"**Possible values:** [`User`, `NeprofileUser`, `NeaccessUser`]"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"profile_id"} required={false} deprecated={undefined} schemaDescription={"The profile this workflow session will be working with. Only Applicable for Update workflows"} schemaName={"uuid"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"profile_ids"} required={false} deprecated={undefined} schemaDescription={"The profiles this workflow session will be working with. Only Applicable for Batch workflows"} schemaName={"uuid[]"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"status"} required={false} deprecated={undefined} schemaDescription={"The status"} schemaName={"string"} qualifierMessage={"**Possible values:** [`api_request_sent`, `approved`, `assigned`, `attempting_to_start_workflow`, `AUTH-STATUS1`, `AUTH-STATUS2`, `AUTH-STATUS3`, `AUTH-STATUS4`, `AUTH-STATUS5`, `AUTH-STATUS6`, `AUTH-STATUS7`, `AUTH-STATUS8`, `AUTH-STATUS9`, `auto_assigned`, `batch_completed`, `checking_for_duplicates`, `closed`, `completed`, `courion_add`, `courion_extend`, `courion_terminate`, `courion_update`, `duplicates_resolved`, `failed`, `fulfilled`, `invitation_sent`, `ldap_provided`, `new`, `non_employee_created`, `non_employee_updated`, `notified`, `pending_approval`, `pending_assignment`, `pending_courion_add`, `pending_courion_extend`, `pending_courion_terminate`, `pending_courion_update`, `pending_creation`, `pending_fulfillment`, `pending_ldap`, `pending_notification`, `pending_profile_select`, `pending_request`, `pending_review`, `pending_status_change`, `pending_stored_procedure`, `pending_trigger`, `pending_update`, `processing`, `profile_check_complete`, `profiles_selected`, `rejected`, `requested`, `reviewed`, `soap_request_sent`, `started_workflow`, `status_changed`, `stored_procedure`, `un_assigned`, `waiting_on_workflow`, `workflow_changed`]"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>attributes</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The attributes

</div><li><div><code>property name*</code><span style={{"opacity":"0.6"}}> string</span></div></li></div></details></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>_metadata</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"limit"} required={false} deprecated={undefined} schemaDescription={"The limit"} schemaName={"int32"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"offset"} required={false} deprecated={undefined} schemaDescription={"The offset"} schemaName={"int32"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"total"} required={false} deprecated={undefined} schemaDescription={"The total"} schemaName={"int32"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"next"} required={false} deprecated={undefined} schemaDescription={"The link to the next page of data"} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"previous"} required={false} deprecated={undefined} schemaDescription={"The link to the previous page of data"} 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  \"workflow_sessions\": [\n    {\n      \"id\": \"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e\",\n      \"uid\": \"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e\",\n      \"workflow_id\": \"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e\",\n      \"requester_id\": \"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e\",\n      \"requester_type\": \"User\",\n      \"profile_id\": \"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e\",\n      \"profile_ids\": [\n        \"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e\",\n        \"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9t\"\n      ],\n      \"status\": \"completed\",\n      \"attributes\": {\n        \"text_attribute_uid\": \"static text\",\n        \"date_attribute_uid\": \"01/15/2020\",\n        \"profile_select_attribute_uid\": \"Profile Name\",\n        \"multiple_profile_select_attribute_uid\": \"Profile Name,Second Profile Name,Third Profile Name\",\n        \"contributor_select_attribute_uid\": \"User Name\",\n        \"multiple_contributor_select_attribute_uid\": \"User Name,Second User Name,Third User Name\"\n      }\n    }\n  ],\n  \"_metadata\": {\n    \"limit\": 50,\n    \"offset\": 100,\n    \"total\": 10000,\n    \"next\": \"/endpoint?limit=10&offset=60\",\n    \"previous\": \"/endpoint?limit=10&offset=40\"\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

Bad Request - unable to complete.

</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"}}><div><div><span className={"badge badge--info"}>oneOf</span><SchemaTabs><TabItem label={"MOD1"} value={"0-item-properties"}><SchemaItem collapsible={false} name={"error"} required={false} deprecated={undefined} schemaDescription={undefined} schemaName={""} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></TabItem><TabItem label={"MOD2"} value={"1-item-properties"}><SchemaItem collapsible={false} name={"error"} required={false} deprecated={undefined} schemaDescription={undefined} schemaName={""} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"errors"} required={false} deprecated={undefined} schemaDescription={undefined} schemaName={""} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></TabItem></SchemaTabs></div></div></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"error\": \"Invalid JSON syntax. Please check your syntax and try again.\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal Server Error - returned on unhandled exceptions.

</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={"error"} required={false} deprecated={undefined} schemaDescription={"A message describing the error"} schemaName={""} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"error\": \"Sorry something went wrong\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div>