Getting workflow details

Retrieve details of a workflow within a project.

1. In a REST client platform, add the authentication details of the tenant that is associated with the workflow whose details you want to retrieve.

   
   //In case of Instance API key 
   Headers:
   {
   "x-instance-api-key": "instance_api_key"
   }
    
   // In case of MCSP or ISV token
   Headers:
   {
   "Authorization": "mcsp_or_isv_token"
   }

2. Make a GET request at the URL of the workflow.
   URL Syntax - <domain>/apis/v1/rest/projects/<project_name>/workflows/<workflow_name>
   If the request is successful, you receive the response code for success.

   {
            "name": "<workflow_name>",
            "description": "<workflow_description>",
            "refid": "<workflow_refid>",
            "sid": "<workflow_sid>",
            "uid": "<workflow_uid>",
            "project_uid": "<workflow_project_uid>",
            "tenant_uid": "<workflow_tenant_uid>"
          }

   Note:

   • If multiple workflows share name, the API provides a list of all matching workflows, including their UIDs and names. You can then select the relevant workflow UID from this list and use it in the URL path.
   • API calls are case-sensitive for project_name and workflow_name.