Workflows

Get workflow by ID

get/v1/workflows/{id}

Request

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

Path parameters

idstring required

Workflow ID

Query parameters

include_deletedboolean

Include deleted workflows

Headers

Organization-Idstring required

Organization ID

Response

OK

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"
  }
}

Changes

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