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

---
id: get-workflow-actions
sidebar_label: Get Workflow Actions
hide_title: true
hide_table_of_contents: true
api: eJytV1lv4zYQ/iuEnuMz1yZAgaZtunDR3S2StH0IAmNEjSwmEqklKTuG4f/eGUry2isn6xTJgyORc3xzj1aRKdGCV0ZPkugymqH/19inNDeLK8mnLjqKEnTSqpJfieQuU06gTkqjtBcStLDorcI5ikXDKmDD62Hmosv7qHP1cBSVYKFAj5YpVpGmF5LfUk5VQvyKVX6t0C47QFqgYvKbSI0VqcpJltIzorT4tVIWyaQUcodHkZMZFhBdriK/LFmN8w0psRbg6aSqgkZ8hqLMmSSO4UKm8bh3cSZHvROQcQ/k+UUPxqPz4/Hp+Hx8dhqt1w+szpVkFDpWMB4O+d8u2OvnEqXHRLSkwhsBYg654jOy0HlSLo32qD3zQ1nmSobQDB4dC1l1rTDxI4klxtJyIL2qIWx82Hr7cA7ywQFO+uZfbyvspshWLviskxgixtzomSMf9Hc8fnycDs/HSdIbHccnvZMRjnofEIa90Vk6htOL+PRcfojW36nrou1Evwtv60SYdB/IXWQ3tUhBUbGGoiZSawoB2hCnFZWjH0pBEDNrqpIl8pETC+UzOnUUfJUqKazJsc8WlDDDd/M1C9vrZ5eZKuf80gna/+dqSJJpk59op+CmZqHRbuGODdkEOpRnClXu9+Oc1E7eiGqxxeTTJKHCABcIgvg2JORrqupQK0QnLQKV0I4drIpQUlWofAqefBhX/u2efTFPNiKF84bFBFxBHeOmanah+fwwgQ71d2NJLRq3KxesheU+1Mpj4V611+Oz79RNsG/HEjzMlvvo0WQ6MfjzjLn70hR0/Qgad88eSKPGxdR58NUBAA8KCAkUtcAN1tv69dcM9OwHUeChNscjMdHQPH3R4k8EfrpDWyjNGRby3sqMCJLXM30vzMnefiJobLZCuVdQ69jBFkSRYvekyhJiPnpHzRupr6lu3O+mFL2iGUPvg6CVTL2wkf0yDgLilQ/h2t1FaNby31F0sm/C/gKJuKm7i+iJSgdjqXGQPhLusf+W8Wo0fknDVvL92GyhTXSY3X8w6/roZbp/mCqoubbW0KqzfqiNON1nxITwWU3j5RbtnPpg4CFzaMWqrObE0WQaJXqS0ws+Swyc7k3Gvb4JIKvsIrsSBXUIHjT1ebzphYF+u8hujbVL4QztdhlTLTjcC0sTv4kgWc93ptk4GQL4jF4GncWF6iF4ol4RK5sTVeZ96S4HgxWZC9p/pr1x3dcUMtJvlojcfAZQKmKeg1WcCHX32ZDX5jV5HIEsUJruohvIBa+lNJycmrH/OaEqGgUFzcB12P0cysoqvwwAYwSL9qpia+4ftq9v2f01jm2iTTTYqKjZU0PBBSI6qR9+bzvlnXlCTTDo96elqWz9GLFPlU4NS2R31SaM+sP+cCsZP1/ffBJXf032LPUo2suw09O4pQ0m2AtS8pSjnBOFSVS6FOxVQx2XCpoQ0K1QWgQwqOeKAs0FzilJSYi06zKoZrv/NLkLWEvjfAF66+YjerFZ6V/4+Fh9S/K3fofUXuY5MyhzUFy0dTqtmuS7727NFL6McPLdahWDw79tvl7zcf1FwhFPlOMEe2FkbQN+7XtlL7wnXHa+h6jpVEwZcW612R1yjbAiJLyaEaqa9Upyf9ji6vQFlrIpxY/XHJv/AHLW5cw=
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 Actions' (get-workflow-actions)"
---

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 Actions</h1>

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



This endpoint can retrieve workflow actions

## 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":"workflow_id","in":"query","description":"Workflow ID for filtering","required":false,"schema":{"type":"string","format":"uuid","example":"bba9cfb2-96c1-4acb-ac79-a21732527265"}}}></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_actions</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"workflow_id"} required={false} schemaName={"uuid"} qualifierMessage={undefined} schema={{"type":"string","format":"uuid","required":true,"description":"The workflow the workflow action belongs to.","example":"33f072dd-13b4-41e1-8ea0-16f2a59b57c8"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","required":false,"description":"The description of the workflow action.","example":"Require approval from another user or a group of users with a specific role."}}></SchemaItem><SchemaItem collapsible={false} name={"page_id"} required={false} schemaName={"uuid"} qualifierMessage={undefined} schema={{"type":"string","format":"uuid","required":true,"description":"The page the workflow action should render.","example":"33f072dd-13b4-41e1-8ea0-16f2a59b57c8"}}></SchemaItem><SchemaItem collapsible={false} name={"add_requester_as_owner"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","default":true,"description":"If the requester should be added as the owner of the profile to be created.","example":true}}></SchemaItem><SchemaItem collapsible={false} name={"email_attribute_id"} required={false} schemaName={"uuid"} qualifierMessage={undefined} schema={{"type":"string","format":"uuid","required":false,"description":"The attribute storing the email address for the workflow action.","example":"33f072dd-13b4-41e1-8ea0-16f2a59b57c8"}}></SchemaItem><SchemaItem collapsible={false} name={"email_addresses"} required={false} schemaName={"text[]"} qualifierMessage={undefined} schema={{"type":"array","required":false,"items":{"type":"string","format":"text"},"description":"The email addresses for the workflow action.","example":["johndoe@gmail.com","janedoe@gmail.com"]}}></SchemaItem><SchemaItem collapsible={false} name={"new_status"} required={false} schemaName={"text"} qualifierMessage={undefined} schema={{"type":"string","format":"text","required":false,"description":"The new status for the Status Change workflow action.","example":"Active, Inactive, On Leave, Terminated"}}></SchemaItem><SchemaItem collapsible={false} name={"archived"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","default":false,"description":"If the workflow action is archived or not.","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"skippable"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","default":false,"description":"If the workflow action is skippable or not.","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"requires_comment"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","default":false,"description":"If the workflow action requires a comment or not.","example":false}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"workflow_actions\": {\n    \"workflow_id\": \"33f072dd-13b4-41e1-8ea0-16f2a59b57c8\",\n    \"description\": \"Require approval from another user or a group of users with a specific role.\",\n    \"page_id\": \"33f072dd-13b4-41e1-8ea0-16f2a59b57c8\",\n    \"add_requester_as_owner\": true,\n    \"email_attribute_id\": \"33f072dd-13b4-41e1-8ea0-16f2a59b57c8\",\n    \"email_addresses\": [\n      \"johndoe@gmail.com\",\n      \"janedoe@gmail.com\"\n    ],\n    \"new_status\": \"Active, Inactive, On Leave, Terminated\",\n    \"archived\": false,\n    \"skippable\": false,\n    \"requires_comment\": false\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>