connectors

List the connectors the calling consumer is permitted to use.

GET

http://localhost:8000

/api/connectors/v1/{namespace}/{namespaceId}/connectors

Returns the catalogue entries the consumer is allowed to connect — the set a connect flow can name. Describes what each connector is, not any connection to it.

List the connectors the calling consumer is permitted to use. › path Parameters

namespace

string · enum · required

What the connection is based off of.

Enum values:

workspace

namespaceId

string · required

Identifier of the namespace instance the connection belongs to.

List the connectors the calling consumer is permitted to use. › Headers

Sqsp-Connector-On-Behalf-Of

string

The member or agent id this call acts on behalf of. Honoured only for a caller on this service's original-client allowlist.

List the connectors the calling consumer is permitted to use. › Responses

The permitted connectors.

The connectors available to the calling consumer.

ListConnectorsResponse

Connector[] · required

The permitted connectors.

GET/api/connectors/v1/{namespace}/{namespaceId}/connectors

curl http://localhost:8000/api/connectors/v1/:namespace/:namespaceId/connectors

Example Responses

{
  "connectors": [
    {
      "authentication": "authentication",
      "callSurface": "callSurface",
      "displayName": "displayName",
      "id": "id",
      "kind": "kind",
      "metadata": {
        "category": "productivity",
        "description": "description",
        "developer": {
          "name": "name",
          "url": "url"
        },
        "iconUrl": "iconUrl",
        "links": {
          "privacyPolicy": "privacyPolicy",
          "support": "support",
          "website": "website"
        },
        "permissions": "permissions",
        "tools": [
          {
            "annotations": {
              "destructiveHint": true,
              "readOnlyHint": true
            },
            "description": "description",
            "name": "name"
          }
        ]
      },
      "scopes": [
        "string"
      ]
    }
  ]
}

json

application/json

grants