---
title: "Get workflow instance details"
method: GET
path: "/v1/workflows/instances/{id}"
tags: ["Instances"]
---

# Get workflow instance details

`GET /v1/workflows/instances/{id}`

## Request

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

Returns detailed information about a workflow execution instance, including all current step states.

## Path parameters

- `id` string, required

## Headers

- `Organization-Id` string, required

## Response `200`

Instance details

- GetInstanceResponse
  - `data` InstanceDetailDTO
    - `created_at` string
    - `error` string: The failure reason. The stored chain for a superuser, the same text as error_detail for everyone else
    - `error_code` string: Why the run failed, from a closed set. internal_error when the run predates classification
    - `error_detail` string: What the caller is told about the failure
    - `input` object
    - `instance_id` string
    - `internal` boolean
    - `livemode` boolean
    - `organization_id` string
    - `output` object
    - `status` string
    - `steps` CurrentStepDTO[]
      - `definition_path` string: Position of the step in the workflow definition, such as "2", "2.steps.0" or "0.then.1". A step recorded before positions were stored shows its step_index
      - `error` string: The failure reason. The stored chain for a superuser, the same text as error_detail for everyone else
      - `error_code` string: Why the step failed, from a closed set. internal_error when the step predates classification
      - `error_detail` string: What the caller is told about the failure
      - `input` object
      - `iteration` integer: 0-based loop iteration that ran the step; null when the step did not run inside a loop
      - `output` object
      - `started_at` string
      - `status` string
      - `step_index` integer
      - `step_name` string
      - `terminated_at` string
    - `terminated_at` string
    - `updated_at` string
    - `workflow_description` string
    - `workflow_id` string
    - `workflow_name` string

## Other responses

- `400`: Invalid instance ID
- `401`: authentication_failed, missing_authorization_header, unsupported_auth_method or jwt_signature_invalid when the credential is missing, malformed or rejected; accountid_identity_required when a superuser or service-to-service caller sends the Account-ID header
- `404`: instance_not_found, the instance is not found in this account and mode
- `500`: Internal server error
- `502`: accountid_relationship_lookup_failed or accountid_account_lookup_failed when an upstream service does not answer
- `503`: upstream_unavailable when an upstream service does not answer
- `504`: service_timeout when the request exceeds its deadline

---

[API](https://skmtc.dev/paymongo/apis/workflow.md) - [All operations](https://skmtc.dev/paymongo/apis/workflow/llms.txt) - [OpenAPI document](https://skmtc.dev/paymongo/apis/workflow/revisions/859719cfffa2?raw)