GET

api

platform

knowledge_base

{kb_id}

connector-doc-data

{connector_id}

Get Connector Doc Data

curl --request GET \
  --url https://unpod.ai/api/v2/platform/knowledge_base/{kb_id}/connector-doc-data/{connector_id}/ \
  --header 'Authorization: <api-key>' \
  --header 'Org-Handle: <org-handle>'

import requests

url = "https://unpod.ai/api/v2/platform/knowledge_base/{kb_id}/connector-doc-data/{connector_id}/"

headers = {
    "Org-Handle": "<org-handle>",
    "Authorization": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'Org-Handle': '<org-handle>', Authorization: '<api-key>'}
};

fetch('https://unpod.ai/api/v2/platform/knowledge_base/{kb_id}/connector-doc-data/{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://unpod.ai/api/v2/platform/knowledge_base/{kb_id}/connector-doc-data/{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 => [
    "Authorization: <api-key>",
    "Org-Handle: <org-handle>"
  ],
]);

$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://unpod.ai/api/v2/platform/knowledge_base/{kb_id}/connector-doc-data/{connector_id}/"

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

	req.Header.Add("Org-Handle", "<org-handle>")
	req.Header.Add("Authorization", "<api-key>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://unpod.ai/api/v2/platform/knowledge_base/{kb_id}/connector-doc-data/{connector_id}/")
  .header("Org-Handle", "<org-handle>")
  .header("Authorization", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://unpod.ai/api/v2/platform/knowledge_base/{kb_id}/connector-doc-data/{connector_id}/")

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

request = Net::HTTP::Get.new(url)
request["Org-Handle"] = '<org-handle>'
request["Authorization"] = '<api-key>'

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

{
  "status_code": 200,
  "message": "Doc data fetched successfully",
  "data": {
    "document_id": "670f1c2e9b1d4a0012ab34cd",
    "name": "Jane Doe",
    "overview": {
      "summary": "Jane has been contacted 4 times regarding renewal. She responds best in the evening and has shown high interest.",
      "profile_status": "qualified",
      "analytics": {
        "total_calls": 4,
        "connected_calls": 3,
        "response_rate": "75%",
        "avg_call_duration": "3m 42s",
        "last_connected": "2025-11-08T05:32:29Z",
        "next_call_scheduled": "2025-11-15T10:00:00Z",
        "preferred_time": "Evening",
        "sentiment": "positive"
      }
    }
  }
}

{
  "status_code": 401,
  "message": "Authentication credentials were not provided."
}

{
  "status_code": 200,
  "message": "Doc data fetched successfully",
  "data": {
    "document_id": "670f1c2e9b1d4a0012ab34cd",
    "name": "Jane Doe",
    "overview": {
      "summary": "Jane has been contacted 4 times regarding renewal. She responds best in the evening and has shown high interest.",
      "profile_status": "qualified",
      "analytics": {
        "total_calls": 4,
        "connected_calls": 3,
        "response_rate": "75%",
        "avg_call_duration": "3m 42s",
        "last_connected": "2025-11-08T05:32:29Z",
        "next_call_scheduled": "2025-11-15T10:00:00Z",
        "preferred_time": "Evening",
        "sentiment": "positive"
      }
    }
  }
}

{
  "status_code": 401,
  "message": "Authentication credentials were not provided."
}

Get People

Retrieve the People profile (connector doc data) for a knowledge base’s connector document - powers the People tab in Call Logs, including summary, profile status, and call analytics for a contact.

Prerequisites: Make sure you have your API Token and Org-Handle ready. See Authentication for details.

Headers

Name	Type	Required	Description
Org-Handle	string	Yes	Organization domain handle
Authorization	string	Yes	API Key format: `Token <token>`

You can get the Org-Handle by hitting the Get All Organizations API. The domain_handle field in the response is your Org-Handle.

Path Parameters

Name	Type	Required	Description
kb_id	string	Yes	Knowledge base token
connector_id	string	Yes	Connector document id

Query Parameters

Name	Type	Required	Description
domain	string	No	Filter connector doc data by domain
page	integer	No	Page number for pagination (default = 1)
page_size	integer	No	Number of items per page (default = 20)

Response Fields

Field	Type	Description
status_code	integer	HTTP status code
message	string	Response message
data	object	People / connector doc data object

Data Object Fields

Field	Type	Description
document_id	string	Connector document id
name	string	Contact/person name
overview.summary	string	AI-generated summary of the contact
overview.profile_status	string	Profile status, e.g. `qualified`
overview.analytics	object	Call analytics for this contact

Analytics Object Fields

Field	Type	Description
total_calls	integer	Total number of calls with this contact
connected_calls	integer	Number of connected calls
response_rate	string	Response rate percentage
avg_call_duration	string	Average call duration
last_connected	string	Timestamp of last connected call
next_call_scheduled	string	Timestamp of next scheduled call, if any
preferred_time	string	Contact’s preferred time to be called
sentiment	string	Overall sentiment, `null` if not available

Common Error Codes

Status Code	Description
200	Success - People data fetched successfully
400	Bad Request - Invalid filter parameters
401	Unauthorized - Invalid or missing API token
403	Forbidden - Invalid organization handle or no access to this knowledge base
404	Not Found - Knowledge base or connector document not found
500	Internal Server Error - Server-side error

Code Examples

const axios = require('axios');

const headers = {
  'Authorization': 'Token your-api-token',
  'Org-Handle': 'your-org-handle'
};

const getPeople = async (kbId, connectorId, filters = {}) => {
  const params = {
    page: 1,
    page_size: 20,
    ...filters
  };
  const response = await axios.get(
    `https://unpod.ai/api/v2/platform/knowledge_base/${kbId}/connector-doc-data/${connectorId}/`,
    { headers, params }
  );
  console.log(response.data.data.overview.summary);
  return response.data.data;
};

getPeople('kb-token', 'connector-id');

import requests

headers = {
    'Authorization': 'Token your-api-token',
    'Org-Handle': 'your-org-handle'
}

def get_people(kb_id: str, connector_id: str, page: int = 1, page_size: int = 20, **filters):
    """Get People / connector doc data"""
    url = f'https://unpod.ai/api/v2/platform/knowledge_base/{kb_id}/connector-doc-data/{connector_id}/'
    params = {'page': page, 'page_size': page_size, **filters}
    response = requests.get(url, headers=headers, params=params)
    data = response.json()
    print(data['data']['overview']['summary'])
    return data['data']

get_people('kb-token', 'connector-id')

curl -X GET "https://unpod.ai/api/v2/platform/knowledge_base/kb-token/connector-doc-data/connector-id/?page=1&page_size=20" \
  -H "Org-Handle: your-org-handle" \
  -H "Authorization: Token your-api-token"

Best Practices

Pagination: Use page and page_size when fetching large result sets
Domain Filter: Use domain to scope connector doc data when a knowledge base spans multiple domains
Org-Handle: Ensure the correct organization handle is included
Security: Keep API tokens secure and rotate them regularly

Authorizations

Authorization

string

header

required

Format: Token

Headers

Org-Handle

string

required

Organization domain handle

Example:

"unpod.tv"

Path Parameters

kb_id

string

required

Knowledge base token.

Example:

"8KZAMRAHSXXXXXXMAYNASMJC"

connector_id

string

required

Connector document id.

Example:

"670f1c2e9b1d4a0012ab34cd"

Query Parameters

domain

string

Filter connector doc data by domain.

Example:

"acme.com"

page

integer

Example:

1

page_size

integer

Example:

20

Response

Connector doc data (People profile) for the given knowledge base connector document

Get Connector Doc Data

curl --request GET \
  --url https://unpod.ai/api/v2/platform/knowledge_base/{kb_id}/connector-doc-data/{connector_id}/ \
  --header 'Authorization: <api-key>' \
  --header 'Org-Handle: <org-handle>'

import requests

url = "https://unpod.ai/api/v2/platform/knowledge_base/{kb_id}/connector-doc-data/{connector_id}/"

headers = {
    "Org-Handle": "<org-handle>",
    "Authorization": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'Org-Handle': '<org-handle>', Authorization: '<api-key>'}
};

fetch('https://unpod.ai/api/v2/platform/knowledge_base/{kb_id}/connector-doc-data/{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://unpod.ai/api/v2/platform/knowledge_base/{kb_id}/connector-doc-data/{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 => [
    "Authorization: <api-key>",
    "Org-Handle: <org-handle>"
  ],
]);

$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://unpod.ai/api/v2/platform/knowledge_base/{kb_id}/connector-doc-data/{connector_id}/"

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

	req.Header.Add("Org-Handle", "<org-handle>")
	req.Header.Add("Authorization", "<api-key>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://unpod.ai/api/v2/platform/knowledge_base/{kb_id}/connector-doc-data/{connector_id}/")
  .header("Org-Handle", "<org-handle>")
  .header("Authorization", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://unpod.ai/api/v2/platform/knowledge_base/{kb_id}/connector-doc-data/{connector_id}/")

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

request = Net::HTTP::Get.new(url)
request["Org-Handle"] = '<org-handle>'
request["Authorization"] = '<api-key>'

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

{
  "status_code": 200,
  "message": "Doc data fetched successfully",
  "data": {
    "document_id": "670f1c2e9b1d4a0012ab34cd",
    "name": "Jane Doe",
    "overview": {
      "summary": "Jane has been contacted 4 times regarding renewal. She responds best in the evening and has shown high interest.",
      "profile_status": "qualified",
      "analytics": {
        "total_calls": 4,
        "connected_calls": 3,
        "response_rate": "75%",
        "avg_call_duration": "3m 42s",
        "last_connected": "2025-11-08T05:32:29Z",
        "next_call_scheduled": "2025-11-15T10:00:00Z",
        "preferred_time": "Evening",
        "sentiment": "positive"
      }
    }
  }
}

{
  "status_code": 401,
  "message": "Authentication credentials were not provided."
}

Getting Started

API Lists

Get People

Get People

Headers

Path Parameters

Query Parameters

Response Fields

Data Object Fields

Analytics Object Fields

Common Error Codes

Code Examples

Best Practices

Authorizations

Headers

Path Parameters

Query Parameters

Response

​Get People

​Headers

​Path Parameters

​Query Parameters

​Response Fields

​Data Object Fields

​Analytics Object Fields

​Common Error Codes

​Code Examples

​Best Practices

Authorizations

Headers

Path Parameters

Query Parameters

Response

Get People

Headers

Path Parameters

Query Parameters

Response Fields

Data Object Fields

Analytics Object Fields

Common Error Codes

Code Examples

Best Practices