Skip to main content
POST
/
api
/
v1
/
connectors
Create Connector
curl --request POST \
  --url https://api.example.com/api/v1/connectors \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "<string>",
  "client_id": "<string>",
  "client_secret": "<string>",
  "metadata": {},
  "match_preset": true
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "url": "<string>",
  "state": "created",
  "auth_request": {
    "authorization_endpoint": "<string>",
    "type": "code"
  },
  "disconnect_reason": "<string>",
  "metadata": {},
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json
​
url
string<uri>
required
Minimum string length: 1
​
client_id
string | null
​
client_secret
string | null
​
metadata
Metadata · object

Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard.

Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters.

​
match_preset
boolean
default:true

Response

Successful Response

​
id
string<uuid>
required
​
url
string<uri>
required
Minimum string length: 1
​
state
enum<string>
required
Available options:
created,
auth_required,
connected,
disconnected
​
auth_request
AuthorizationCodeRequest · object
required
​
disconnect_reason
string | null
required
​
metadata
Metadata · object
required

Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard.

Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters.

​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
created_by
string<uuid>
required