Get a list of executable workflows

GET

Get a list of workflows that can be executed

Headers

X-Frankie-CustomerIDstringRequired

Your Customer ID provided by FrankieOne

X-Frankie-CustomerChildIDstringOptional

Your Customer Child ID provided by FrankieOne

X-Frankie-ChannelstringOptional

Open string that can be used to define the “channel” the request comes in from. It can potentially be used in routing and risk calculations upon request. Default values that can be used are: api portal smartui Any alphanumeric string is supported though. Anything over 64 characters will be truncated.

X-Frankie-UsernamestringOptional

Username provided by API caller

Query parameters

serviceNamestringOptional

The unique name of the service profile

Response

requestIdstringOptional

The unique request ID for the API call made.

workflowslist of objectsOptional

Provide a set of workflow lookup objects.

Execute a workflow for the given service profile

Up Next

Built with

1	curl https://api.uat.frankie.one/v2/workflows \
2	-H "X-Frankie-CustomerID: 12345678-1234-1234-1234-123456789012" \
3	-H "X-Frankie-CustomerChildID: 87654321-4321-4321-4321-210987654321" \
4	-H "X-Frankie-Username: fred.flintstone@frankieone.com" \
5	-H "api_key: <apiKey>"

1	{
2	"requestId": "01HN9XHZN6MGXM9JXG50K59Q85",
3	"workflows": [
4	{
5	"serviceName": "serviceName",
6	"workflowId": "workflowId",
7	"workflowName": "workflowName",
8	"type": "type",
9	"lifecyclePhase": "ONBOARDING",
10	"monitoringTypes": [
11	"monitoringTypes"
12	]
13	}
14	]
15	}