Get connector

GET /connectors/{connector_guid}

Returns the details of a connector, including its optional and required input parameters.

Path Parameters

Name	Description	Type
connector_guid	Use List connectors to find the guid of a connector.	string

Results

200

{
     "guid": "0d86f238-27c0-11ea-921c-022e6b5ea1e2",
     "name": "Google Sheets",
     "description": "...",
     "authentication_type": "oAuth2 3-legged"
     "params": [
        {
           "guid": "0d86f238-27c0-11ea-921c-022e6b5ea1e2",
           "name": "app_id",
           "type": "string",
           "example_value": "my-app-id",
           "is_required": false|true
        },
        {
           "guid": "0d86f238-27c0-11ea-921c-022e6b5ea1e2",
           "name": "app_key",
           "type": "password",
           "example_value": "my-api-key",
           "is_required": false|true
        },
        {
           "guid": "0d86f238-27c0-11ea-921c-022e6b5ea1e2",
           "name": "environment",
           "type": "select",
           "example_value": "production",
           "options": ["production", "staging"]
        }
     ]
  }

400

{}

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – let us know how we can improve!

Leave your feedback here