Get connectors

GET /api/connectors

Get all connectors in the current tenant.

Query parameters

  • target string

    Filter connectors by target.

Responses

  • 200 application/json

    An array of connectors.

    Hide response attributes Show response attributes object
    • id string Required
    • syncProfile boolean Required
    • config object Required

      arbitrary

    • metadata object Required
      Hide metadata attributes Show metadata attributes object
      • target string
      • name object

        Validator function

      • logoDark string | null
    • connectorId string Required

      Minimum length is 1, maximum length is 128.

    • target string Required
    • name object Required

      Validator function

    • description object Required

      Validator function

    • logoDark string | null Required
    • readme string Required
    • configTemplate string
    • formItems array[object]
      One of:
    • customData object
    • fromEmail string
    • platform string | null Required

      Values are Native, Universal, or Web.

    • isStandard boolean
    • isTokenStorageSupported boolean
    • type string Required

      Values are Email, Sms, or Social.

    • isDemo boolean
    • extraInfo object
    • usage number
  • 400

    The target only allows one connector to exist, but there are multiple connectors with this target.

  • 401

    Unauthorized

  • 403

    Forbidden

GET /api/connectors
curl \
 --request GET 'https://[tenant_id].logto.app/api/connectors' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200)
[
  {
    "id": "string",
    "syncProfile": true,
    "config": {},
    "metadata": {
      "target": "string",
      "name": {},
      "logo": "string",
      "logoDark": "string"
    },
    "connectorId": "string",
    "target": "string",
    "name": {},
    "description": {},
    "logo": "string",
    "logoDark": "string",
    "readme": "string",
    "configTemplate": "string",
    "formItems": [
      {
        "type": "string",
        "selectItems": [
          {
            "value": "string",
            "title": "string"
          }
        ],
        "key": "string",
        "label": "string",
        "placeholder": "string",
        "required": true,
        "showConditions": [
          {
            "targetKey": "string"
          }
        ],
        "description": "string",
        "tooltip": "string",
        "isConfidential": true
      }
    ],
    "customData": {},
    "fromEmail": "string",
    "platform": "Native",
    "isStandard": true,
    "isTokenStorageSupported": true,
    "type": "Email",
    "isDemo": true,
    "extraInfo": {},
    "usage": 42.0
  }
]