v2

latestOpenAPI 3.0.4Apache 2.0raw.githubusercontent.com2026-07-1754198241.7 KB
Connectors

List connector instances

Lists connector instances registered for the tenant. Use this endpoint to find durable integration endpoints by connector family, data-flow role, or logical operation support. A connector instance is not itself a resource shape; resource descriptors and operation bindings describe what the connector can read or write.

get/connectors

Query parameters

connectorTypestring

Extensible connector family identifier. This names the connector implementation or adapter family, not the transport, resource kind, or representation.

Example:http.openapi

Filters by extensible connector runtime family, for example http.openapi, sql.postgresql, identity.oidc, storage.vault, storage.blob, interaction.form, or internal.party-semantic-store. CSV remains a representation kind, not a connector type.

role'SOURCE' | 'DESTINATION'

How a connector participates in data movement. Use SOURCE for reads and DESTINATION for writes. Connectors that support both roles declare both values in supportedRoles.

Example:SOURCE

Filters connectors or attached resources by data-flow role.

operationKind'READ' | 'WRITE' | 'UPDATE' | 'DELETE' | 'UPSERT' | 'QUERY' | 'SEARCH' | 'IMPORT' | 'EXPORT' | 'INVOKE' | 'DISCOVER' | 'VALIDATE'

Reusable operation taxonomy shared by connectors, inventory, policy, and workflows. The operation kind is logical; connector-local details live in operationName.

Example:READ

Filters by the logical operation taxonomy, independent of the transport-specific operation name.

pageinteger

Zero-based page index.

sizeinteger

Page size.

Response

Paged connector instances.

Example response

{
  "data": [
    {
      "connectorInstanceId": "3f6f4f46-24fb-4c35-a7a4-bc6c7f7861f5",
      "partyId": "f9c97b4e-e756-4b70-b230-6f1d9f81b426",
      "displayName": "Workday employee profile API",
      "connectorType": "http.openapi",
      "lifecycleStatus": "ACTIVE",
      "supportedRoles": [
        "SOURCE"
      ],
      "createdAt": "2026-06-18T08:30:00Z",
      "updatedAt": "2026-06-18T08:45:00Z"
    }
  ],
  "pagination": {
    "limit": 20,
    "offset": 0,
    "page": 0,
    "size": 20,
    "total": 1,
    "totalPages": 1,
    "hasMore": false
  }
}
All 54 operations