Connector

Get Connectors

get

Get all connectors of the user.

Authorizations

OAuth2PasswordBearerAPIKeyHeader

OAuth2passwordRequired

Token URL:

cookie

__Secure-next-auth.session-tokenany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

422

Validation Error

application/json

get

/connectors

HTTPcURLJavaScriptPython

GET /connectors HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "connectors": [
    {
      "id": "text",
      "name": "text",
      "display_name": "text",
      "description": "text",
      "icon": "text",
      "is_connected": true,
      "user_identifier": "text"
    }
  ]
}

Get Connector Data

get

Get connector data.

Authorizations

OAuth2PasswordBearerAPIKeyHeader

OAuth2passwordRequired

Token URL:

cookie

__Secure-next-auth.session-tokenany ofOptional

stringOptional

or

nullOptional

Path parameters

connector_namestringRequired

Responses

200

Successful Response

application/json

422

Validation Error

application/json

get

/connectors/{connector_name}

HTTPcURLJavaScriptPython

GET /connectors/{connector_name} HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "user_identifier": "text",
  "auth_string": "text"
}

Connect

post

Connect to a connector.

Authorizations

OAuth2PasswordBearerAPIKeyHeader

OAuth2passwordRequired

Token URL:

cookie

__Secure-next-auth.session-tokenany ofOptional

stringOptional

or

nullOptional

Path parameters

connector_namestringRequired

Body

application/x-www-form-urlencoded

callback_urlstringRequired

Responses

200

Successful Response

application/json

422

Validation Error

application/json

post

/connectors/{connector_name}/connect

HTTPcURLJavaScriptPython

POST /connectors/{connector_name}/connect HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 23

"callback_url='text'"

{
  "redirect_url": "text"
}

Disconnect From Connector

post

Disconnect from a connector.

Authorizations

OAuth2PasswordBearerAPIKeyHeader

OAuth2passwordRequired

Token URL:

cookie

__Secure-next-auth.session-tokenany ofOptional

stringOptional

or

nullOptional

Path parameters

connector_namestringRequired

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

post

/connectors/{connector_name}/disconnect

HTTPcURLJavaScriptPython

POST /connectors/{connector_name}/disconnect HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content