PayMongo HomeGuidesAPI ReferenceStart Building
API Reference

List workflow instances with current step info

get
https://api.paymongo.com/v1/workflows/instances

Returns paginated list of workflow execution instances with their current step status. Supports filtering by workflow_id, status, and current_step_status.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

Filter by workflow ID

string
enum

Filter by instance status

Allowed:
string
enum

Filter by current step status

Allowed:
string

Filter by external reference source

string

Filter by external reference external ID

string

Filter by external reference ID prefix; returns all matching instances (mutually exclusive with external_id)

integer
1 to 100

Page size (default: 10, max: 100)

integer
≥ 0

Page offset (default: 0)

Headers
string
required

Organization ID

Responses

Updated 20 days ago

Did this page help you?
Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 20 days ago

Did this page help you?