PApaymongo
Workflows

List workflows

get/v1/workflows

Request

  • Base URL
    https://api.paymongo.com
  • URL
    https://api.paymongo.com/v1/workflows
  • Auth
    none required

Query parameters

limitinteger

Limit (default: 10, max: 100)

after_idstring

Return the page after this position: either the opaque next_cursor from a previous response, or a bare workflow ID; excludes before_id

before_idstring

Return the page before this position: either the opaque prev_cursor from a previous response, or a bare workflow ID; excludes after_id

sort_by'created_at' | 'updated_at'

Sort column (default: created_at descending)

sort_order'asc' | 'desc'

Sort direction; requires sort_by

namestring

Filter by exact name

name_likestring

Filter by name pattern (case-insensitive)

include_deletedboolean

Include deleted workflows

only_deletedboolean

Show only deleted workflows

Headers

Organization-Idstring required

Organization ID

Response

OK

has_moreboolean

HasMore is true when more results exist beyond this page: after the last row when paging forward, before the first row when paging backward with before_id.

next_cursorstring

Opaque cursor for the last row on the page. Echo it as after_id to read the next page. It normally carries the sort it was issued under, so sort_by need not be repeated; for a very long text sort value the API falls back to a plain row id, which carries no sort, so a client pinning a non-default sort should keep sending sort_by. Omitted when the page has no rows.

prev_cursorstring

Opaque cursor for the first row on the page. Echo it as before_id to read the previous page. It normally carries the sort it was issued under, so sort_by need not be repeated; for a very long text sort value the API falls back to a plain row id, which carries no sort, so a client pinning a non-default sort should keep sending sort_by. Omitted when the page has no rows.

Example response

{
  "data": [
    {
      "created_at": "2026-01-15 10:30:00+00:00",
      "deleted_at": "2026-01-16 10:30:00+00:00",
      "description": "Handles merchant payout disbursement",
      "id": "flow_abc123",
      "livemode": true,
      "name": "Payout Workflow",
      "organization_id": "org_abc123",
      "trigger_summary": {
        "count": 2,
        "triggers": [
          {
            "event_name": "payment.paid",
            "id": "tr_abc123",
            "state": "active",
            "type": "event"
          }
        ]
      },
      "updated_at": "2026-01-15 10:30:00+00:00"
    }
  ],
  "meta": {
    "limit": 10
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.