How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Openwork Connectors API

The Connectors API from Openwork — 21 operation(s) for connectors.

Openwork Connectors API is one of 37 APIs that Openwork publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Connectors. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 29 operations across 21 paths, and defines 33 schemas. It is described by OpenAPI 3.1.0, at version dev.

Requests are made against a single base URL, https://api.openworklabs.com.

29 operations 21 paths 33 schemas 2 DELETE11 GET3 PATCH13 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
dev
Base URL
https://api.openworklabs.com
Authentication
HTTP Bearer, API Key
Resource Areas
1

Authentication & Security 2

Openwork Connectors API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (session-token) (bearerAuth). An API key is passed in the header as x-api-key (denApiKey).

  • bearerAuth — Session token passed as Authorization: Bearer for user-authenticated Den routes.
  • denApiKey — Organization API key passed as the x-api-key header for API-key-authenticated Den routes.

Paths & Operations 29

Across 21 paths, the API surfaces 29 operations — 2 DELETE, 11 GET, 3 PATCH, 13 POST. Each is listed below with its method, path, parameters, and response codes.

Connectors 29
GET
/v1/connector-accounts
List connector accounts
getV1ConnectorAccounts 5 params → 200400401
POST
/v1/connector-accounts
Create connector account
postV1ConnectorAccounts body → 201400401403
GET
/v1/connector-accounts/{connectorAccountId}
Get connector account
getV1ConnectorAccountsByConnectorAccountId 1 param → 200400401404
POST
/v1/connector-accounts/{connectorAccountId}/disconnect
Disconnect connector account
postV1ConnectorAccountsByConnectorAccountIdDisconnect 1 param body → 200400401403404
GET
/v1/connector-instances
List connector instances
getV1ConnectorInstances 7 params → 200400401
POST
/v1/connector-instances
Create connector instance
postV1ConnectorInstances body → 201400401403404
GET
/v1/connector-instances/{connectorInstanceId}
Get connector instance
getV1ConnectorInstancesByConnectorInstanceId 1 param → 200400401404
PATCH
/v1/connector-instances/{connectorInstanceId}
Update connector instance
patchV1ConnectorInstancesByConnectorInstanceId 1 param body → 200400401403404
POST
/v1/connector-instances/{connectorInstanceId}/archive
archive connector instance
postV1ConnectorInstancesByConnectorInstanceIdArchive 1 param → 200400401403404
POST
/v1/connector-instances/{connectorInstanceId}/disable
disable connector instance
postV1ConnectorInstancesByConnectorInstanceIdDisable 1 param → 200400401403404
POST
/v1/connector-instances/{connectorInstanceId}/enable
enable connector instance
postV1ConnectorInstancesByConnectorInstanceIdEnable 1 param → 200400401403404
GET
/v1/connector-instances/{connectorInstanceId}/configuration
Get connector instance configuration
getV1ConnectorInstancesByConnectorInstanceIdConfiguration 1 param → 200400401404
POST
/v1/connector-instances/{connectorInstanceId}/remove
Remove connector instance
postV1ConnectorInstancesByConnectorInstanceIdRemove 1 param → 200400401403404
POST
/v1/connector-instances/{connectorInstanceId}/auto-import
Set connector instance auto-import
postV1ConnectorInstancesByConnectorInstanceIdAutoImport 1 param body → 200400401403404
GET
/v1/connector-instances/{connectorInstanceId}/access
List connector instance access grants
getV1ConnectorInstancesByConnectorInstanceIdAccess 1 param → 200400401403404
POST
/v1/connector-instances/{connectorInstanceId}/access
Grant connector instance access
postV1ConnectorInstancesByConnectorInstanceIdAccess 1 param body → 201400401403404
DELETE
/v1/connector-instances/{connectorInstanceId}/access/{grantId}
Revoke connector instance access
deleteV1ConnectorInstancesByConnectorInstanceIdAccessByGrantId 2 params → 204400401403404
GET
/v1/connector-instances/{connectorInstanceId}/targets
List connector targets
getV1ConnectorInstancesByConnectorInstanceIdTargets 5 params → 200400401404
POST
/v1/connector-instances/{connectorInstanceId}/targets
Create connector target
postV1ConnectorInstancesByConnectorInstanceIdTargets 1 param body → 201400401403404
GET
/v1/connector-targets/{connectorTargetId}
Get connector target
getV1ConnectorTargetsByConnectorTargetId 1 param → 200400401404
PATCH
/v1/connector-targets/{connectorTargetId}
Update connector target
patchV1ConnectorTargetsByConnectorTargetId 1 param body → 200400401403404
POST
/v1/connector-targets/{connectorTargetId}/resync
Resync connector target
postV1ConnectorTargetsByConnectorTargetIdResync 1 param → 202400401403404
GET
/v1/connector-targets/{connectorTargetId}/mappings
List connector mappings
getV1ConnectorTargetsByConnectorTargetIdMappings 7 params → 200400401404
POST
/v1/connector-targets/{connectorTargetId}/mappings
Create connector mapping
postV1ConnectorTargetsByConnectorTargetIdMappings 1 param body → 201400401403404
PATCH
/v1/connector-mappings/{connectorMappingId}
Update connector mapping
patchV1ConnectorMappingsByConnectorMappingId 1 param body → 200400401403404
DELETE
/v1/connector-mappings/{connectorMappingId}
Delete connector mapping
deleteV1ConnectorMappingsByConnectorMappingId 1 param → 204400401403404
GET
/v1/connector-sync-events
List connector sync events
getV1ConnectorSyncEvents 7 params → 200400401
GET
/v1/connector-sync-events/{connectorSyncEventId}
Get connector sync event
getV1ConnectorSyncEventsByConnectorSyncEventId 1 param → 200400401404
POST
/v1/connector-sync-events/{connectorSyncEventId}/retry
Retry connector sync event
postV1ConnectorSyncEventsByConnectorSyncEventIdRetry 1 param → 202400401403404

Schemas 33

The contract defines 33 schemas that model the data the API accepts and returns. The most detailed are PluginArchConnectorInstanceConfiguredPlugin (14 properties), PluginArchConnectorInstance (14 properties), PluginArchConnectorMapping (13 properties), PluginArchConnectorAccount (12 properties). Each schema is shown below with its type and property counts.

PluginArchAccessGrantMutationResponse
object
2 properties 2 required
PluginArchConnectorAccount
object
12 properties 10 required
PluginArchConnectorTargetDetailResponse
object
1 property 1 required
PluginArchConnectorMappingListResponse
object
2 properties 2 required
PluginArchConnectorInstanceMutationResponse
object
2 properties 2 required
PluginArchConnectorSyncEventListResponse
object
2 properties 2 required
PluginArchConnectorInstanceConfiguredPlugin
object
14 properties 10 required
PluginArchConnectorAccountDisconnectResponse
object
2 properties 2 required
PluginArchConnectorInstanceRemoveResponse
object
2 properties 2 required
PluginArchConnectorTargetMutationResponse
object
2 properties 2 required
PluginArchConnectorSyncEvent
object
12 properties 12 required
PluginArchConnectorInstanceConfigurationResponse
object
2 properties 2 required
PluginArchConnectorSyncAsyncResponse
object
3 properties 3 required
PluginArchConnectorMappingMutationResponse
object
2 properties 2 required
UnauthorizedError
object
1 property 1 required
PluginArchConnectorTargetListResponse
object
2 properties 2 required
PluginArchConnectorInstance
object
14 properties 14 required
NotFoundError
object
2 properties 1 required
PluginArchAccessGrant
object
8 properties 8 required
PluginArchExtensionProjection
object
5 properties 5 required
PluginArchConnectorSyncEventDetailResponse
object
1 property 1 required
ForbiddenError
object
3 properties 1 required
PluginArchConnectorInstanceDetailResponse
object
1 property 1 required
PluginArchConnectorAccountDetailResponse
object
1 property 1 required
PluginArchConnectorTarget
object
9 properties 9 required
PluginArchAccessGrantListResponse
object
2 properties 2 required
PluginArchConnectorAccountListResponse
object
2 properties 2 required
PluginArchConnectorInstanceListResponse
object
2 properties 2 required
InvalidRequestError
object
2 properties 2 required
PluginArchConnectorMapping
object
13 properties 13 required
PluginArchConnectorSyncSummary
object
6 properties
OpenWorkExtensionManifest
object
9 properties 6 required
PluginArchConnectorAccountMutationResponse
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

openwork-connectors-api-openapi.yml Raw ↑

Other APIs Openwork publishes across the network.

Openwork Admin API
Openwork API Keys API
Openwork Auth API
Openwork Authentication API
Openwork Bootstrap API
Openwork Capability Sources API
Openwork Config Objects API
Openwork Desktop Policies API
Openwork Dev API
Openwork Diagnostics API
Openwork GitHub API
Openwork Inference API
Where this information came from

This is an independent, third-party profile of Openwork Connectors API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.