Displaying a List of Workflows

You can use the API to recreate a filterable list of Workflows found in the AlphaTrust Control Panel inside your own application.

Workflow List

Request Body

The request properties:

Property	Type	Description	Required
`UserID`	integer	The ID of the user making the request. Example: `0`.	Yes
`ProntoID`	string	The Pronto ID associated with the workflow. Example: `"string"`.	No
`Name`	string	The name of the workflow (supports partial matches). Example: `"string"`.	No
`IsPublicLaunch`	boolean	Filters workflows that can be publicly launched. Example: `true`.	No
`IsPrivate`	boolean	Filters workflows marked as private. Example: `true`.	No
`IsGroupShared`	boolean	Filters workflows shared with a group. Example: `true`.	No
`IsSubGroupShared`	boolean	Filters workflows shared with a subgroup. Example: `true`.	No
`EnableLogging`	boolean	Enables logging for this request (specific behavior may depend on system).	No

Example Request Body:

{
    "UserID": 0,
    "ProntoID": "string",
    "Name": "string",
    "IsPublicLaunch": true,
    "IsPrivate": true,
    "IsGroupShared": true,
    "IsSubGroupShared": true,
    "EnableLogging": true
}

Response

Status Codes
- 200 OK: The request was successful, and workflows are returned.
- 401 Unauthorized: Authentication credentials are missing or invalid.
- 404 Not Found: No workflows match the provided filters, or the endpoint is incorrect.
- 500 Internal Server Error: An unexpected error occurred on the server.

Response Body The response is a JSON object with the following structure:

{
  "IsSuccessful": boolean,
  "Message": string,
  "Workflows": [
    {
      "ID": string (GUID),
      "ProntoID": string,
      "Name": string,
      "CreatedBy": string,
      "CreatedDate": string (ISO 8601),
      "LastModifiedDate": string (ISO 8601),
      "IsPublicLaunch": boolean,
      "IsPrivate": boolean,
      "IsGroupShared": boolean,
      "IsSubGroupShared": boolean
    }
  ],
  "ProcessingTime": string,
  "TimeZoneUtcOffset": integer
}

IsSuccessful: Indicates if the request succeeded (true/false).
Message: A string with additional information (e.g., "string").
Workflows: An array of workflow objects, each with:
- ID: A GUID string (e.g., "00000000-0000-0000-0000-000000000000").
- ProntoID: The workflow’s Pronto ID (e.g., "string").
- Name: The workflow’s name (e.g., "string").
- CreatedBy: The creator’s identifier (e.g., "string").
- CreatedDate: Creation timestamp in ISO 8601 format (e.g., "2025-06-10T15:05:37.001Z").
- LastModifiedDate: Last modification timestamp in ISO 8601 format (e.g., "2025-06-10T15:05:37.001Z").
- IsPublicLaunch: Public launch status (true/false).
- IsPrivate: Privacy status (true/false).
- IsGroupShared: Group sharing status (true/false).
- IsSubGroupShared: Subgroup sharing status (true/false).
ProcessingTime: Time taken to process the request (e.g., "string").
TimeZoneUtcOffset: UTC offset in hours (e.g., 0).

Sample Response:

{
    "IsSuccessful": true,
    "Message": "string",
    "Workflows": [
        {
            "ID": "00000000-0000-0000-0000-000000000000",
            "ProntoID": "string",
            "Name": "string",
            "CreatedBy": "string",
            "CreatedDate": "2025-06-10T15:05:37.001Z",
            "LastModifiedDate": "2025-06-10T15:05:37.001Z",
            "IsPublicLaunch": true,
            "IsPrivate": true,
            "IsGroupShared": true,
            "IsSubGroupShared": true
        }
    ],
    "ProcessingTime": "string",
    "TimeZoneUtcOffset": 0
}

Examples

CURL Example

Request

curl -X POST "https://uat.alphatrust.com/rest/workflows" \
     -H "Authorization: Bearer YOUR_API_TOKEN" \
     -H "Content-Type: application/json" \
     -d '{
           "UserID": 0,
           "ProntoID": "string",
           "Name": "string",
           "IsPublicLaunch": true,
           "IsPrivate": true,
           "IsGroupShared": true,
           "IsSubGroupShared": true,
           "EnableLogging": true
         }'

Response

{
    "IsSuccessful": true,
    "Message": "string",
    "Workflows": [
        {
            "ID": "00000000-0000-0000-0000-000000000000",
            "ProntoID": "string",
            "Name": "string",
            "CreatedBy": "string",
            "CreatedDate": "2025-06-10T15:05:37.001Z",
            "LastModifiedDate": "2025-06-10T15:05:37.001Z",
            "IsPublicLaunch": true,
            "IsPrivate": true,
            "IsGroupShared": true,
            "IsSubGroupShared": true
        }
    ],
    "ProcessingTime": "string",
    "TimeZoneUtcOffset": 0
}

Note: The example uses a test environment URL (https://uat.alphatrust.com/rest). Adjust the base URL for production (e.g., https://esign.alphatrust.com/rest).

C# Example

var req = new WorkflowListRequestModel()
          {
              ProntoID = "MyAccountID"
          };

var api = new WorkflowsApi(myRestEndpointUrl);
var results = api.GetWorkflowList(req, apiKey, apiSecret, apiUsername, apiPassword);

if (results.IsSuccessful.Value)
{
    var listOfWorkflows = results.Workflows;

    // do work
}

The response to the API call will contain a list of workflows and each will have an ID. You can use that ID to get the rules for the Workflow in order to create your launch page.

Error Handling

401 Unauthorized: Verify your authentication token or credentials.
404 Not Found: Ensure the endpoint URL is correct and that workflows exist for the specified filters.
500 Internal Server Error: Retry the request or contact support if the issue persists.