Links a connector to an agent.

POST

https://api.awork.com/api/v1/agents/:agentId/connectors/:connectorId

POST

/api/v1/agents/:agentId/connectors/:connectorId

curl -X POST https://api.awork.com/api/v1/agents/agentId/connectors/connectorId \
     -H "Authorization: Bearer <token>"

{
  "id": "23e68187-91d6-4f7e-8d31-e3f2c60d7427",
  "createdOn": "2022-03-11T15:33:47.100Z",
  "createdBy": "9ad63972-4396-4b0b-9e7d-40b852cdebf8",
  "updatedOn": "2022-03-11T21:15:00.100Z",
  "updatedBy": "3d844c62-7410-4df9-a5b2-78805c0ee260",
  "ownerUserId": "9ad63972-4396-4b0b-9e7d-40b852cdebf8",
  "canDelete": true,
  "name": "Client CRM",
  "description": "HubSpot CRM for lead and client account research.",
  "url": null,
  "presetKey": "hubspot",
  "endpointValues": [
    {
      "key": "region",
      "labelKey": "dataRegion",
      "value": "eu",
      "displayLabelKey": "eu"
    }
  ],
  "logoPath": "images/integrations/hubspot_icon.svg",
  "status": "connected",
  "isSharedWithWorkspace": true,
  "isOwner": true,
  "currentUserConnectionStatus": "connected",
  "lastRefreshedOn": "2026-08-29T08:05:00Z",
  "currentUserLastAuthenticatedOn": "2026-08-29T08:00:00Z",
  "hasOAuthClientConfiguration": true,
  "connectionMode": "actingUser",
  "connectionId": "af18602d-c8aa-4f63-a21e-5a7f59b2412c",
  "currentUserConnectionId": "af18602d-c8aa-4f63-a21e-5a7f59b2412c",
  "connections": [
    {
      "canUse": true,
      "canDelete": true,
      "isSuspended": false,
      "id": "af18602d-c8aa-4f63-a21e-5a7f59b2412c",
      "connectorId": "7e376777-7834-4af6-9eb8-da065f568d30",
      "ownerUserId": "9ad63972-4396-4b0b-9e7d-40b852cdebf8",
      "name": "Client CRM connection",
      "externalIdentity": "account.manager@northstar.agency",
      "status": "connected",
      "isSharedWithWorkspace": true,
      "isOwner": true,
      "lastAuthenticatedOn": "2026-08-29T08:00:00Z",
      "lastRefreshedOn": "2026-08-29T08:05:00Z"
    }
  ]
}

Links an existing connector to the specified agent and returns the linked connector. Use GET /agents/connectors to find a connector id.

Required Permissions

The user must have manage access to the agent.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

agentIdstringRequiredformat: "uuid"

The agent id.

connectorIdstringRequiredformat: "uuid"

The connector id.

Response

idstringOptionalformat: "uuid"

The id of the entity.

createdOnstringOptionalformat: "date-time"

The date this entity was created.

createdBystringOptionalformat: "uuid"

The id of the user who created this entity.

updatedOnstringOptionalformat: "date-time"

The date this entity was last modified.

updatedBystringOptionalformat: "uuid"

The id of the user who last modified this entity.

ownerUserIdstring or nullOptionalformat: "uuid"

The connector owner, or null for a preset without configuration. CreatedBy remains audit history.

canDeletebooleanOptional

Whether the requesting user can delete the connector and all its connections.

namestring or nullOptional

The connector display name.

descriptionstring or nullOptional

The connector description.

urlstring or nullOptional

The custom connector URL.

presetKeystring or nullOptional

The predefined connector key.

endpointValueslist of objects or nullOptional

The safely displayable configured endpoint values.

logoPathstring or nullOptional

The preset logo path when this server matches a catalog preset.

statusstring or nullOptional

The aggregate connection status.

isSharedWithWorkspacebooleanOptional

Whether the connector is shared with the workspace.

isOwnerbooleanOptional

Whether the current user owns the connector.

currentUserConnectionStatusstring or nullOptional

The current user's connection status.

lastRefreshedOnstring or nullOptionalformat: "date-time"

When the server tools were last refreshed.

currentUserLastAuthenticatedOnstring or nullOptionalformat: "date-time"

When the current user last authenticated this server.

hasOAuthClientConfigurationbooleanOptional

Whether static OAuth client credentials are configured.

connectionModestring or nullOptional

The selected connection resolution mode for an agent-linked response.

connectionIdstring or nullOptionalformat: "uuid"

The selected specific connection, when applicable.

currentUserConnectionIdstring or nullOptionalformat: "uuid"

The connection selected by the current user for acting-user resolution.

connectionslist of objects or nullOptional

The connections visible to the current user.

Errors

401

Unauthorized Error

404

Not Found Error