get_connector

Read one Connectors Marketplace card by key — its lane, badges and, for a connector that exists as a package, its manifest and the form that connects it.

Purpose

Answer "what can this connector do?" or "what does connecting it ask the creator for?" for one connector. The card is the same list_connectors returns: status and installable, official and the badges, the category, tagline, overview and links, and for a registered connector the manifest with its resource_kinds, capabilities, messaging limits, pacing, management_commands and missing_commands, recovery facets and the declarative install_fields and settings_fields. A roadmap entry (coming_soon) answers too, with every manifest key null or empty. The REST twin is GET /v1/connectors/{key}.

Required ability

project-connector:view-any

Input schema

{
  "type": "object",
  "required": ["connector"],
  "properties": {
    "connector": {
      "type": "string",
      "description": "The connector key, as list_connectors returns it."
    }
  }
}

Output shape

{
  "data": {
    "key": "telegram",
    "name": "Telegram",
    "vendor": "Subscriby",
    "version": "1.0.0",
    "status": "available",
    "status_label": "Available Now",
    "installable": true,
    "official": true,
    "badges": [{ "key": "official", "label": "Official" }],
    "category": "messaging",
    "tagline": "Sell access to Telegram channels, groups and supergroups through your own bot.",
    "links": { "documentation": "https://docs.subscriby.net/guide/connectors/telegram", "support": "mailto:[email protected]", "privacy": "https://telegram.org/privacy", "terms": "https://telegram.org/tos", "homepage": "https://telegram.org" },
    "added_at": "2025-04-21",
    "install_mode": "paste_credential",
    "scopes": ["project", "platform"],
    "resource_kinds": [
      { "kind": "channel", "label": "Channel", "portal_label": "Channel", "icon": "megaphone", "grant_mode": "bearer_link", "supports_early_admission_hold": true }
    ],
    "capabilities": ["messaging", "access_control", "management_surface", "recovery_probes"],
    "messaging": { "max_length": 4096, "buttons_per_row": 8, "max_buttons": 100, "callback_data_bytes": 64, "supports_underline": true, "supports_spoiler": true, "supports_files": true },
    "pacing": { "min_interval_microseconds": 35000, "burst": 30, "per_recipient_interval_microseconds": 1000000 },
    "management_commands": ["project_create", "plan_manage"],
    "missing_commands": ["creator_tasks"],
    "recovery": { "probes": true, "standby_installations": true, "resource_standby": false, "mirror": false, "identity_relink": false },
    "install_fields": [
      { "name": "token", "type": "secret", "label": "Bot token", "help": "Paste the token @BotFather gave you.", "required": true, "rules": ["string"], "options": [], "value": null, "steps": [], "links": {} }
    ],
    "settings_fields": []
  },
  "meta": {}
}

Example prompts

"Does the Telegram connector support holding early admission for passes?"

"What are the message length limits on Discord?"

Failure modes

  • AUTHENTICATION_REQUIRED — no authenticated user on the request.
  • TOKEN_MISSING_ABILITY — token lacks project-connector:view-any.
  • RESOURCE_NOT_FOUND — no connector is known by that key; context.connector echoes it.

How is this guide?

On this page

Subscriby is a product designed by you — for you.

No boardroom full of executives deciding what we ships next. Our roadmap always shaped by you with your feedback.

Share feedback or a request