List connector types and instances

GET

/api/v1/connectors

const url = 'https://api.ultimateteam.ai/api/v1/connectors';
const options = {method: 'GET', headers: {'X-API-Key': '<X-API-Key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.ultimateteam.ai/api/v1/connectors \
  --header 'X-API-Key: <X-API-Key>'

Returns all available connector types and the tenant’s connected instances.

Authorizations

ApiKeyAuth

Responses

200

Successful Response

application/json

ListConnectorsResponse

Response for GET /connectors.

Attributes: available_types: All registered connector types. connected: Connector instances for this tenant.

object

available_types

required

Available Types

Array<object>

ConnectorTypeInfo

Metadata for an available connector type.

Attributes: slug: URL-safe identifier (e.g. ‘stripe’). display_name: Human-readable name. description: What this connector provides. auth_type: Authentication mechanism.

object

auth_type

required

Auth Type

string

description

required

Description

string

display_name

required

Display Name

string

setup_fields

required

Setup Fields

Array<object>

ConnectorSetupField

object

destination

Destination

boolean

label

required

Label

string

name

required

Name

string

numeric

Numeric

boolean

required

Required

boolean

default: true

secret

Secret

boolean

setup_method

required

Setup Method

string

Allowed values: oauth credentials internal

slug

required

Slug

string

connected

required

Connected

Array<object>

ConnectorInstanceInfo

Metadata for a connected connector instance.

Attributes: connector_id: Unique instance identifier. service_slug: The connector type slug. display_name: Human-readable name. status: Current lifecycle status.

object

connector_id

required

Connector Id

string

display_name

required

Display Name

string

service_slug

required

Service Slug

string

status

required

Status

string

Example

{
  "available_types": [
    {
      "setup_fields": [
        {
          "destination": false,
          "numeric": false,
          "required": true,
          "secret": false
        }
      ],
      "setup_method": "oauth"
    }
  ]
}