Skip to main content
GET
/
contents
/
v1
/
connectors
/
{connector_id}
Get connector by ID
curl --request GET \
  --url https://api.bigdata.com/contents/v1/connectors/{connector_id} \
  --header 'X-API-KEY: <api-key>'
{
  "connector_id": "019a9612-bfad-758c-884e-37dd8c6ad2cb",
  "user_id": "user_id_001",
  "org_id": "org_id_001",
  "share_with_org": true,
  "label": "Broker Research - Daily Reports",
  "type": "email",
  "created_at": "2026-02-11T11:01:09.574095Z",
  "updated_at": "2026-02-11T11:01:09.574102Z",
  "archived": false,
  "description": "Collects daily reports from the broker's research team",
  "config": {
    "allowed_emails": [
      "user@example.com",
      "admin@example.com"
    ],
    "email_hash": "a1b2c3d4e5f6",
    "email": "connector@bigdata.com"
  },
  "files_count": 10,
  "last_sync_at": "2026-04-07T09:36:34.195040Z",
  "last_sync_status": "SUCCESS",
  "last_sync_error_msg": null,
  "last_sync_count": 3200
}

Documentation Index

Fetch the complete documentation index at: https://docs.bigdata.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-API-KEY
string
header
required

Your API key. Include it in every request as the X-API-KEY header. Create and manage keys in the Developer Platform.

Path Parameters

​
connector_id
string<uuid>
required

UUID of the connector (returned when creating or listing connectors).

Example:

"019a9612-bfad-758c-884e-37dd8c6ad2cb"

Response

The connector object. Configuration contains type-specific data (e.g. allowed_emails, inbox address).

An ingestion source (e.g. email inbox or investment research / broker feed). Returned by Create/Get/Update connector and List connectors.

​
connector_id
string<uuid>
required

Unique identifier for the connector. Use when updating, deleting, or filtering documents by connector.

Example:

"019a9612-bfad-758c-884e-37dd8c6ad2cb"

​
user_id
string
required

ID of the user who owns the connector.

Example:

"user_id_001"

​
org_id
string
required

ID of the organization the connector belongs to.

Example:

"org_id_001"

​
share_with_org
boolean
required

If true, all members of your organization can access the processed content. If false, only you can access the processed content.

Example:

true

​
label
string
required

Display name for the connector (e.g. for UI or admin lists).

Example:

"Broker Research - Daily Reports"

​
type
enum<string>
required

Connector type. Determines the configuration and how content is ingested.

Available options:
email,
investment_research
​
created_at
string<date-time>
required

Timestamp when the connector was created.

Example:

"2026-02-11T11:01:09.574095Z"

​
updated_at
string<date-time>
required

Timestamp when the connector was last updated.

Example:

"2026-02-11T11:01:09.574102Z"

​
archived
boolean
required

Whether the connector is archived.

Example:

false

​
description
string

Optional human-readable description of what the connector is used for.

Example:

"Collects daily reports from the broker's research team"

​
config
Email · object

Type-specific settings. Email connectors return inbox and allowed senders; investment research connectors return user_id only (never user_password).

​
files_count
integer

Number of files ingested through this connector, when tracked (e.g. investment research sync).

Example:

10

​
last_sync_at
string<date-time> | null

Timestamp of the last sync from the external source, when applicable.

Example:

"2026-04-07T09:36:34.195040Z"

​
last_sync_status
string | null

Outcome of the last sync (e.g. SUCCESS), when applicable.

Example:

"SUCCESS"

​
last_sync_error_msg
string | null

Error message from the last sync when it failed; null on success.

Example:

null

​
last_sync_count
integer | null

Number of items processed in the last sync, when applicable.

Example:

3200