Skip to main content
GET
Read Connector

Authorizations

Authorization
string
header
required

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

Path Parameters

connector_id
string<uuid>
required

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 | null
required
disconnect_reason
string | null
required
metadata
Metadata · object | null
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