Skip to main content
GET
Get connector

Authorizations

Authorization
string
header
required

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

Path Parameters

namespace
string
required

Namespace identifier. This can be an ID for your user, a project ID, or any other identifier you wish to use to scope documents and memories.

Maximum string length: 100
Pattern: ^[a-zA-Z0-9_:-]+$
Example:

"user_alex"

id
string
required

Connector identifier returned when the connector was created

Minimum string length: 1
Example:

"PTzGiUYei7pgzg5buzZHgA"

Query Parameters

include
enum<string>[]

Comma-separated extras. syncs: the 10 most recent sync runs with their failed items. picker: a one-time hosted picker URL.

Available options:
syncs,
picker
returnUrl
string<uri>

Where the hosted picker sends the user when they finish

Response

Connector

id
string
required
provider
enum<string>
required

External source

Available options:
notion,
google-drive,
onedrive,
gmail,
github,
web-crawler,
s3,
granola
namespace
string | null
required

Namespace the connector syncs into. Null only for connectors created before namespaces were required.

account
string | null
required

Account on the provider side, usually an email

capabilities
object
required
config
object | null
required

Non-secret setup, such as the S3 bucket, crawler start URL or Notion workspace. Credentials are never returned.

selection
object | null
required

What syncs, grouped by kind, in the same shape PATCH takes. Null for connectors that sync everything.

Example:
documentLimit
number
required
documentCount
number
required
latestRun
object | null
required

The most recent sync run, which may still be running or may have failed

system
object
required

Lifecycle status and timestamps maintained by Supermemory

authorization
object

Present while pending, when the caller can create connectors in this namespace

syncs
object[]

Present when include=syncs

picker
object | null

Present when include=picker. Null for connectors that sync everything.