Get connector factory

GET /api/connector-factories/{id}
O auth2

Get connector factory by the given ID.

Path parameters

  • id string Required

    The unique identifier of the connector factory.

Responses

  • 200 application/json

    Connector factory data.

    Hide response attributes Show response attributes object
    • type string Required

      Values are Email, Sms, or Social.

    • isDemo boolean
    • id string Required
    • 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:
      object-1 object object-2 object object-3 object
    • customData object
    • fromEmail string
    • platform string | null Required

      Values are Native, Universal, or Web.

    • isStandard boolean
  • 400

    Bad Request

  • 401

    Unauthorized

  • 403

    Forbidden

  • 404

    Connector factory not found.

GET /api/connector-factories/{id} 
curl \
 --request GET 'https://[tenant_id].logto.app/api/connector-factories/{id}' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "type": "Email",
  "isDemo": true,
  "id": "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
}