Runs

List connector runs

Changed on Jul 17, 2026

Lists route and operation runs across the tenant. Use this direct tenant-wide run resource for operational dashboards, customer support, audit trails, retry decisions, and monitoring failed or partially failed imports and exports. Use /routes/{routeId}/runs for route-scoped history.

get/runs

Request

Base URL
https://api.example.com/api/connector/v1
Auth
HTTP bearer
TypeScript
https://skmtc.dev/sphereon-opensource/apis/connector-integration-profile-api/docs/runs/get.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

Execution status of a route run or connector operation run.

Example:SUCCEEDED

Filters connector executions by lifecycle status.

routeIdstring uuid

Stable identifier for a connector route.

Example:1e8ff011-2274-4f16-a7dd-bf0b4fd5262f

Filters connector executions by route id.

connectorInstanceIdstring uuid

Stable platform identifier for a configured connector instance.

Example:3f6f4f46-24fb-4c35-a7a4-bc6c7f7861f5

Filters connector executions by the registry connector instance id.

invocationBindingIdstring

Stable identifier of the domain invocation binding that caused a connector call.

Example:issuer-config-1:post-issuance:proof-vault

Filters connector executions by Phase 5 invocation binding lineage.

logicalConnectionBindingIdstring

Stable identifier of a tenant, OU, brand, legal-entity, or channel usage binding for a physical connector instance.

Example:brand-a-proof-vault

Filters connector executions by logical connection binding lineage.

physicalConnectorInstanceIdstring uuid

Stable platform identifier for a configured connector instance.

Example:3f6f4f46-24fb-4c35-a7a4-bc6c7f7861f5

Filters connector executions by physical connector instance lineage.

Explicit exchange quadrant. Data direction and initiation side remain separate axes in run responses.

Example:PLATFORM_INITIATED_PUSH

Filters connector executions by the Phase 5 data-direction and initiation-side quadrant.

Product, protocol, form, portal, workflow, or application surface that owns a connector invocation binding.

Example:OID4VCI

Filters connector executions by the product, protocol, form, portal, workflow, or application surface that initiated the run.

correlationIdstring

Filters connector executions by durable route-run correlation id.

pageinteger

Zero-based page index.

sizeinteger

Page size.

Response

Paged connector runs.

Example response

{
  "data": [
    {
      "runId": "9a785884-63ea-4b07-9976-264a1fc595f1",
      "routeId": "1e8ff011-2274-4f16-a7dd-bf0b4fd5262f",
      "status": "PARTIALLY_FAILED",
      "startedAt": "2026-06-18T10:20:00Z",
      "finishedAt": "2026-06-18T10:21:12Z",
      "itemCount": 250,
      "successCount": 247,
      "failureCount": 3
    }
  ],
  "pagination": {
    "limit": 20,
    "offset": 0,
    "page": 0,
    "size": 20,
    "total": 1,
    "totalPages": 1,
    "hasMore": false
  }
}

Changes

Jul 17, 202660cb8c70871b Revision changes
- breaking
  removed the enum value EXTERNALLY_INITIATED_READ_FROM_VDX from the query request parameter exchangeMode
- breaking
  removed the enum value EXTERNALLY_INITIATED_WRITE_INTO_VDX from the query request parameter exchangeMode
- warning
  added the new EXTERNALLY_INITIATED_READ enum value to the // response property for the response status
- warning
  added the new EXTERNALLY_INITIATED_WRITE enum value to the // response property for the response status
- warning
  added the new INBOUND enum value to the // response property for the response status
- warning
  added the new OUTBOUND enum value to the // response property for the response status
- info
  added the new enum value EXTERNALLY_INITIATED_READ to the query request parameter exchangeMode
- info
  added the new enum value EXTERNALLY_INITIATED_WRITE to the query request parameter exchangeMode
- info
  removed the EXTERNALLY_INITIATED_READ_FROM_VDX enum value from the // response property for the response status
- info
  removed the EXTERNALLY_INITIATED_WRITE_INTO_VDX enum value from the // response property for the response status
- info
  removed the INTO_VDX enum value from the // response property for the response status
- info
  removed the OUT_OF_VDX enum value from the // response property for the response status
- info
  the //// response's property pattern ^sha256:[0-9a-f]{64}$ was added for the status
- info
  the //// response's property pattern ^sha256:[0-9a-f]{64}$ was added for the status
- info
  the //// response's property pattern ^sha256:[0-9a-f]{64}$ was added for the status
- info
  the //// response's property pattern ^sha256:[0-9a-f]{64}$ was added for the status

Operation history