Connector

object

keyrequired: string
providerrequired: string
namerequired: string
categoryrequired: string
descriptionrequired: string
auth_kindrequired: "oauth" | "api_key" | "inbound_webhook" | "email" | "qr" | "none"
capabilitiesrequired: array of string
statusrequired: "ga" | "beta" | "planned"
logorequired: string
docsrequired: object
docs.summaryrequired: string
docs.readmerequired: string or null
docs.urlrequired: string or null
availablerequired: boolean
It can be connected in this deployment now (see connect_modes).
connect_modesrequired: array of string
How it can be connected now: its own flow (the auth kind, e.g. `oauth`) once PropZolo’s account for it is configured by the platform admin, and/or `own_app` (the tenant’s own app credentials).
noticerequired: string or null
Why a connect flow is missing, for the connect screen.
multiplerequired: boolean
taskrequired: string or null
Roadmap task that builds a planned connector.
connectionsrequired: array of IntegrationConnection

Example

{
  "key": "string",
  "provider": "string",
  "name": "string",
  "category": "string",
  "description": "string",
  "auth_kind": "oauth",
  "capabilities": [
    "string"
  ],
  "status": "ga",
  "logo": "string",
  "docs": {
    "summary": "string",
    "readme": "string",
    "url": "string"
  },
  "available": true,
  "connect_modes": [
    "string"
  ],
  "notice": "string",
  "multiple": true,
  "task": "string",
  "connections": [
    {
      "id": "cmusrceel0000q7kaafxqi1om",
      "provider": "string",
      "connector_key": "string",
      "name": "string",
      "status": "pending",
      "health": "ok",
      "config": {},
      "has_secret": true,
      "secret_hints": {},
      "inbound_url": "string",
      "scopes": [
        "string"
      ],
      "connected_at": "2026-10-06T05:30:00.000Z",
      "connected_by_id": "cmusrceel0000q7kaafxqi1om",
      "last_ok_at": "2026-10-06T05:30:00.000Z",
      "last_error": "string",
      "error_count": 0,
      "created_at": "2026-10-06T05:30:00.000Z",
      "updated_at": "2026-10-06T05:30:00.000Z"
    }
  ]
}

{ "key": "string", "provider": "string", "name": "string", "category": "string", "description": "string", "auth_kind": "oauth", "capabilities": [ "string" ], "status": "ga", "logo": "string", "docs": { "summary": "string", "readme": "string", "url": "string" }, "available": true, "connect_modes": [ "string" ], "notice": "string", "multiple": true, "task": "string", "connections": [ { "id": "cmusrceel0000q7kaafxqi1om", "provider": "string", "connector_key": "string", "name": "string", "status": "pending", "health": "ok", "config": {}, "has_secret": true, "secret_hints": {}, "inbound_url": "string", "scopes": [ "string" ], "connected_at": "2026-10-06T05:30:00.000Z", "connected_by_id": "cmusrceel0000q7kaafxqi1om", "last_ok_at": "2026-10-06T05:30:00.000Z", "last_error": "string", "error_count": 0, "created_at": "2026-10-06T05:30:00.000Z", "updated_at": "2026-10-06T05:30:00.000Z" } ] }