developer.sailpoint.com/docs/api/nerm/v1/get-workflow-sessions.api.mdx

---
id: get-workflow-sessions
sidebar_label: Get workflow sessions
hide_title: true
hide_table_of_contents: true
api: eJytWVtv47YS/iuEHs6TE1/W3mwCLA5SdNuTg7MXNMnpwyIQaIm22ciUSlJJDMP/vTNDiSJ9i7PtPmTF4XA4M5zLR3qdlJXQ3MpS3eTJVTIX9vdSP86K8vlWGANkk/SSXJhMywq5gOdXYdlzw8RMx2X53CRX35PduYdeUnHNl8IKjSzrRMEARP1ZC72CpVIFg3i36wJEGTYrNav4XCrSlXGVM1NqK9X8HJZo8WcttQALZrwwopeYbCGWPLlaJ3ZV4U7l9A+RWWCtNFpspTA4W8iltAGbVFbMhQY+8cKXVQG04WCw6SXlbGbEK5wTYtQ5UDs+YzUoGbIlmRbcijzlNtlsggmvDmzZ7TgZeKHbK41dkcBciOpra6B4qYoyB7LVtdj0vK/B8JksRCrz4w7/5vjYzc/Mlgw+4dDYdHWSl72xcFxLUPIqqWvarzN+LMYfBuPx8Gw8GeZn44v88uzDRTY6u+SD2WAmhu8mYorGeb3r1xT+fSveGKygeHG6O4XeoPtSqv8JNbeL5OrdCIb8pRuGirVx/qpHvYLg0r+h12GfTqf8MptNwYnvM3Asz6ZnPLu4POOj4cW70WR0MXo/iXyKuwoDSryq+28t5z+qfKiLsdzW5rgWPgp3Cg/zy9+gjFD1kioVl1hBGIhp5aIeuVBW2hWDjIFUgPmsREdD4sGsEsiTFaVxsiqhcuRpXNoogi7Lg1legbAnXgDJfUazqrRyJjMqbbgFDSMOLZ4kbew+ojmwau4qkbElOAD1zkReaxEwOTexbMHVXBBrMA6l1VUOJYa0UEyA3eVKiIaab5ObehQsJ4ozQwusSLEb4Mzmagn+RUfQgOZzMeN1gcQZh9qDpFqxgIHXUIuCcZHzCu18gsMKN0B6MJzVBYRO0WzY+eKgm7Ky1tRfcpTaLI8NbDi8n+IlW2ypeLFACdj8um2BEOBLbG+hTL+6ZW6KOER/4ar9vtVTbrNFFLTNMtOscy5V5lmgHyhamx7e7hPSuLVw4JQocAgQONqG6UIEEBOQWi0hAbNHrwhpG+mUYQ5HWQQdj8F+Wk5rWiDVk7Su5ZsmajI3epRV5eyoZJt8nqeVgPIwvKThU3eMeV0VmGngCy1MWbhENCWE05YQUp6CCKpetyxQdqdQNIWBRPpC1abYQ1j0AApxiAP+WvG1tVaG0YHiju0yJuHEFwJNqOCQxEnlb1qWheAqSLeW1XcSggybB5TmBBNIGg0G+F+s26eXiiLJ64DBwRnUOJkHxTArAScpAk5Q+IqmyPX/MChkfTJO873WY8puCdeaE4iEMDWvi4L2c0JzhTKWf1XFqoVRBEPeCBb2SAkxw+tdshc36rctcKyHm9+9oZ7xRTTZ6sc8w7yk4cOmF+LGE/wWB8kdxGhbDOxCmt32/Qz1lU0FTWCEP0u7OGfoM3bt4gUSl1Lwngqnl2CSSLdTAuKw1w5qbf622j9RMY60biDLkbOBmpY2J5m2Na2DDWFf9LU5tWVKpTgNCvH1/d1/zm7vru/ub4fxcBQP38XDcTycxMP38fAiHn6Ih5dN904DramepWEzaIttCi5Lo2LrC2rE3nRX13MP9dp0T0tNff/tdkmDTuDxR9j7uy7UngbijDTAHw4VKlSiwUZph40icoiktmFeGsBETwohU0uM7d+mbqOGdJ8/tue2cUkaILmWtBdOpTHmSrfAbEtuU9Ujl3ai6xUdpQG7LcElTOrBa0dHIJfuAXJpB4pbSmdgBDwatSgA0wCqtAUgDSBTgGhDkB9gcgQS25nbAKQ0xkydQblH7pEltQpTprmqpHBSgRzfTjzIiN4ZfMZsAky0t0VCIEk8MF58i5plXKDixwoLcZZ6sSk1SLJMZgznMMfA4zssg2F/OOmPBqNB4H/n5R3e9jHiC8ImaK+AWiRsn75hWe9WAAjJWUS7W0gdkxqsQmKgBh0QjF1xR5m3rGu16QhOlU7wBl92AFbSEW49xtGrT+rB4w8/bx170MLdSws1aO+UwoM9+rrVh3yrSljyb9r943DwL7fXx/cD17MhXcoD/e8EKeNBEnroc+uMDf3rJeN9aPUnnrPmKYOdsVpRewbA2qbI+VugaqnE1xk9Y257v1XqRhEO/i8uRdR/iO//yEXbfNK61IAOHpwRk31G3IB+GlKU3Qr9BOFCa8AcTdcEgOJ4vVRQCXJoW3B3zAStNG8y7nhACdxyV7NruJkYw+eCOfqULosAoxx/eLC3pdYrZkoIYrrSPINW7FmXWF7aI8S5snmORhU44umkv3sJgMJJrnCPyrWGoE0W1lbmqt9fg71cWcypzTm04LYDn8OZ9wFgweInriVGgotFz+7sa65IcOFcQsruQltiZ3if8w8TFFE11PIlJgtdpIzIoL/aFSk4FVwLfV2jOd8fwulb9L/TI2Tyx4FGJc2dju5yxIRQij5+aQHtXfko4GqIfz+uoLO7T0oYqWYlSkR3OROG54PzQRCNXz799pldf7vZC+PbSZZxhci3Ns5ed1ugB/llmcvZiqFXIb/pfl1rmMXbKikjAEfBSSN+wJiEKBR4eb3y1+LPN3eka1Uau+QqmDn0o0Ok6LoL88O/UjiHYoPqVwWXmKAuctZNoH3fc9uEo1qATji5Xk+5Efe62GyQ7G7ueLr+laG9Vh/U7fAT+17tHsVq+/0eykuNjFRdTt/4pKfyIzrU/8jme16Sj+wZP7P/4N5Hn7GPbL71UP6Du5/yfH1ECc/zw8af/ox0RI3gzapT5KGrolTTIE8Epx+rICPcuusMG1GwaqcBoRRf83/9hDXgL8SoB6c=
sidebar_class_name: "get api-method"
info_path: docs/api/nerm/v1/nerm-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 DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
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 TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Get workflow sessions</h1>

<MethodEndpoint method={"get"} path={"/workflow_sessions"}></MethodEndpoint>



Get workflow sessions

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Query Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"name":"query","in":"query","description":"Allows for pagination and sorting.","required":false,"schema":{"type":"object","properties":{"limit":{"type":"integer","example":100},"offset":{"type":"integer","example":50},"order":{"type":"string","example":"created_at"}},"example":{"limit":100,"offset":50,"order":"created_at"}},"style":"deepObject","explode":true}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"profile_id","in":"query","description":"Profile ID to filter by","required":false,"schema":{"type":"string","format":"uuid","example":"4e480441-451d-47d9-87c2-9a0f0fe135eb"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"uid","in":"query","description":"Workflow session uid for filtering","required":false,"schema":{"type":"string","minLength":32,"maxLength":32}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"workflow_id","in":"query","description":"Workflow ID for filtering","required":false,"schema":{"type":"string","format":"uuid","example":"bba9cfb2-96c1-4acb-ac79-a21732527265"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"requester_id","in":"query","description":"Requester ID for filtering","required":false,"schema":{"type":"string","format":"uuid"}}}></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"]}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"metadata","in":"query","description":"Returns batching metadata in the response","required":false,"schema":{"type":"boolean","default":false,"example":true}}}></ParamsItem></ul></div></details><div><div><ApiTabs><TabItem label={"200"} value={"200"}><div>

Expected response to a valid request

</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>workflow_sessions</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"uuid"} qualifierMessage={undefined} schema={{"type":"string","format":"uuid","readOnly":true}}></SchemaItem><SchemaItem collapsible={false} name={"uid"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** `>= 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"readOnly":true}}></SchemaItem><SchemaItem collapsible={false} name={"workflow_id"} required={false} schemaName={"uuid"} qualifierMessage={undefined} schema={{"type":"string","format":"uuid"}}></SchemaItem><SchemaItem collapsible={false} name={"requester_id"} required={false} schemaName={"uuid"} qualifierMessage={undefined} schema={{"type":"string","format":"uuid"}}></SchemaItem><SchemaItem collapsible={false} name={"requester_type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`User`, `NeprofileUser`, `NeaccessUser`]"} schema={{"type":"string","enum":["User","NeprofileUser","NeaccessUser"]}}></SchemaItem><SchemaItem collapsible={false} name={"profile_id"} required={false} schemaName={"uuid"} qualifierMessage={undefined} schema={{"type":"string","format":"uuid","description":"The profile this workflow session will be working with. Only Applicable for Update workflows"}}></SchemaItem><SchemaItem collapsible={false} name={"profile_ids"} required={false} schemaName={"uuid[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string","format":"uuid"},"description":"The profiles this workflow session will be working with. Only Applicable for Batch workflows"}}></SchemaItem><SchemaItem collapsible={false} name={"status"} required={false} 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`]"} schema={{"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"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>attributes</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem name={"property name*"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>_metadata</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"limit"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer"}}></SchemaItem><SchemaItem collapsible={false} name={"offset"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer"}}></SchemaItem><SchemaItem collapsible={false} name={"total"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer"}}></SchemaItem><SchemaItem collapsible={false} name={"next"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"/endpoint?limit=10&offset=60"}}></SchemaItem><SchemaItem collapsible={false} name={"previous"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"/endpoint?limit=10&offset=40"}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"workflow_sessions\": [\n    {\n      \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n      \"uid\": \"string\",\n      \"workflow_id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n      \"requester_id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n      \"requester_type\": \"User\",\n      \"profile_id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n      \"profile_ids\": [\n        \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\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\": 0,\n    \"offset\": 0,\n    \"total\": 0,\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 className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><div><span className={"badge badge--info"}>oneOf</span><SchemaTabs><TabItem label={"InvalidJson"} value={"0-item-properties"}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"example":"Invalid JSON syntax. Please check your syntax and try again."}}></SchemaItem></TabItem><TabItem label={"ValidationErrors"} value={"1-item-properties"}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"example":"The <object> failed to create/update"}}></SchemaItem><SchemaItem collapsible={false} name={"errors"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"example":{"attribute":"can't be blank"}}}></SchemaItem></TabItem></SchemaTabs></div></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{}"} 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 className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":"Sorry something went wrong"}}></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></div>