API Docs / Operations / Pending Workflow Steps / List Pending Workflow Steps

List Pending Workflow Steps

GET /tenants/{tenant}/pending-workflow-steps

Returns a paged list of manual-mode outbound workflow steps that are ready to send. These are steps where dependencies are met and a user needs to review and trigger the send.

Parameters

NameTypeDescription
tenant* path string

The Tenant.Code

The Tenant.Code

offset query integer (int32)

Number of records to skip (default: 0). Use with limit for pagination.

Number of records to skip (default: 0). Use with limit for pagination.

limit query integer (int32)

Maximum number of records to return (default: 10, max: 50)

Maximum number of records to return (default: 10, max: 50)

sortBy query enum

Field to sort by.

StepName Deadline ClientName StepType

Field to sort by.

StepName Deadline ClientName StepType

sortDesc query boolean

Sort in descending order (true) or ascending order (false, default)

Sort in descending order (true) or ascending order (false, default)

stepType query string

Filter by step type (SendEmail, DocumentRequest, DocumentApproval, ClientConfirmation, SendDataForm)

Filter by step type (SendEmail, DocumentRequest, DocumentApproval, ClientConfirmation, SendDataForm)

assignedUserCode query string

Filter by the user assigned to the step

Filter by the user assigned to the step

assignedTeamCode query string

Filter by the team assigned to the step

Filter by the team assigned to the step

isUnassigned query boolean

When true, returns only steps with no assigned user. Combines with assignedUserCode as OR.

When true, returns only steps with no assigned user. Combines with assignedUserCode as OR.

clientCode query string

Filter by client code

Filter by client code

managerCode query string

Filter by client manager user code

Filter by client manager user code

partnerCode query string

Filter by client partner user code

Filter by client partner user code

taskCategoryCode query string

Filter by task category code

Filter by task category code

search query string

Search across step name, task title, and client name (minimum 3 characters)

Search across step name, task title, and client name (minimum 3 characters)

Responses

401 Unauthorized – Invalid or missing API key