Get connector by ID

Get connector by ID

curl --request GET \
  --url https://api.bigdata.com/contents/v1/connectors/{connector_id} \
  --header 'X-API-KEY: <api-key>'

const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};

fetch('https://api.bigdata.com/contents/v1/connectors/{connector_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.bigdata.com/contents/v1/connectors/{connector_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-KEY: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.bigdata.com/contents/v1/connectors/{connector_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-KEY", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.bigdata.com/contents/v1/connectors/{connector_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "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",
  "enrichments": [
    "translation"
  ],
  "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
}

GET

contents

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>'

const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};

fetch('https://api.bigdata.com/contents/v1/connectors/{connector_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.bigdata.com/contents/v1/connectors/{connector_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-KEY: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.bigdata.com/contents/v1/connectors/{connector_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-KEY", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.bigdata.com/contents/v1/connectors/{connector_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "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",
  "enrichments": [
    "translation"
  ],
  "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
}

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 with type-specific config. For sharepoint, config is always {} (session_id is never returned).

An ingestion source (e.g. email inbox, investment research / broker feed, or Microsoft SharePoint). 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"

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,

sharepoint

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"

enrichments

enum<string>[]

Enrichments applied to content ingested through this connector. Each value adds a step to the processing pipeline.

Supported enrichments:

reporting_entities: Identifies the document's reporting company, using the same concept as the ReportingEntity reporting detail in Search. This keeps the reporting entity consistent with the rest of the Bigdata corpus, so you can reliably filter private content, transcripts and filings together.
translation: Translates the document content so non-English material can be searched and analyzed alongside the rest of your corpus. Supports more than 70 languages.

Available options:

reporting_entities,

translation

Example:

["translation"]

config

Email · object

Type-specific settings. Email connectors return inbox and allowed senders; investment research connectors return user_id and rolling_history_days (null when not set), never user_password; SharePoint connectors return config as {}.

Email
Investment research
SharePoint

Show child attributes

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

API

Knowledge Graph

Search Service

Watchlists

Monitors

Research Service

Content

Structured Data

Subscription

SDK

Authorizations

Path Parameters

Response