v1

latestOpenAPI 3.1.0Payrails GmbH2026-07-2614905.7 MB

Workflows

Get the default workflow configuration

Get the default workflow configuration version.

get/merchant/workflows/{workflowCode}/versions/default

workflowCodestring required

Machine-friendly code of Workflow.

Path parameter to specify the workflow code.

includeResolvedRulesetsboolean

Boolean indicating if resolved rulesets should be included in the response.

includeResolvedUserboolean

Boolean indicating if resolved user information should be included in the response.

filter[workspaceId]string

Filter by Workspace ID.

Workflow configuration version.

createdAtstring date-time required

Creation date of the workflow configuration.

workflowCodestring required

Machine-friendly code of Workflow.

workspaceIdstring uuid required

Workspace ID that the workflow configuration belongs to.

createdBystring email

User email. The values are set with the credentials of the request owner.

descriptionstring

Description for the workflow.

versioninteger required

Version of a Workflow Configuration.

setAsDefaultBystring email nullable

User email who set this workflow version as default.

setAsDefaultAtstring date-time

Timestamp when this configuration was set as default.