Skip to main content
GET
List Workflows

Authorizations

token
string
header
required

Your Youverify API secret key. Never expose client-side.

Headers

token
string
required

API secret token

Query Parameters

workflowType
enum<string>

Filter by workflow type: CO (Customer Onboarding) or TM (Transaction Monitoring).

Available options:
CO,
TM
isLive
boolean

Filter by whether the workflow is live.

q
string

Search text.

startDate
string

Return workflows from this date.

endDate
string

Return workflows up to this date.

limit
integer

Number of records per page.

sortField
string

Field to sort by.

sortOrder
enum<string>

Sort direction.

Available options:
asc,
desc
next
string

Cursor for the next page.

prev
string

Cursor for the previous page.

Response

Success

success
boolean
required
Example:

true

statusCode
enum<integer>
required
Available options:
200
Example:

200

message
enum<string>
required
Available options:
Workflows fetched successfully
Example:

"Workflows fetched successfully"

data
object
required