Skip to main content
POST
/
v1
/
connectors
List all connectors for the authenticated organization
curl --request POST \
  --url https://app.textql.com/v1/connectors \
  --header 'Authorization: Bearer <token>' \
  --header 'Connect-Protocol-Version: <connect-protocol-version>' \
  --header 'Content-Type: application/json' \
  --data '{}'
{
  "connectors": [
    {
      "athenaMetadata": {
        "region": "<string>",
        "database": "<string>",
        "workgroup": "<string>",
        "s3OutputLocation": "<string>",
        "athenaAuth": {
          "accessKey": {
            "accessKeyId": "<string>",
            "secretAccessKey": "<string>"
          }
        }
      },
      "id": 123,
      "name": "<string>",
      "connectorType": "CONNECTOR_TYPE_UNSPECIFIED",
      "memberId": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "isExample": true,
      "allowSqlWriteOperations": true,
      "authStrategy": "<string>",
      "authenticatedByMemberId": "<string>",
      "memberAuthenticated": true,
      "memberAuthUsername": "<string>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
Connect-Protocol-Version
enum<number>
required

Define the version of the Connect protocol

Available options:
1
​
Connect-Timeout-Ms
number

Define the timeout, in ms

Body

application/json

The body is of type ListConnectorsRequest · object.

Response

Success

​
connectors
Connector · object[]