curl --request POST \
--url https://api.bigdata.com/v1/private-company-people/query \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"identifier": {
"type": "rp_entity_id",
"value": "UWCVKI"
},
"limit": 100
}
'import requests
url = "https://api.bigdata.com/v1/private-company-people/query"
payload = {
"identifier": {
"type": "rp_entity_id",
"value": "UWCVKI"
},
"limit": 100
}
headers = {
"X-API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({identifier: {type: 'rp_entity_id', value: 'UWCVKI'}, limit: 100})
};
fetch('https://api.bigdata.com/v1/private-company-people/query', 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/v1/private-company-people/query",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'identifier' => [
'type' => 'rp_entity_id',
'value' => 'UWCVKI'
],
'limit' => 100
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.bigdata.com/v1/private-company-people/query"
payload := strings.NewReader("{\n \"identifier\": {\n \"type\": \"rp_entity_id\",\n \"value\": \"UWCVKI\"\n },\n \"limit\": 100\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-KEY", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.bigdata.com/v1/private-company-people/query")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"identifier\": {\n \"type\": \"rp_entity_id\",\n \"value\": \"UWCVKI\"\n },\n \"limit\": 100\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.bigdata.com/v1/private-company-people/query")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"identifier\": {\n \"type\": \"rp_entity_id\",\n \"value\": \"UWCVKI\"\n },\n \"limit\": 100\n}"
response = http.request(request)
puts response.read_body{
"results": [
{
"name": "Sam Altman",
"title": "Co-Founder and CEO",
"role_type": "executive",
"is_current": true,
"started_on": {
"value": "2015-12-08",
"precision": "day"
},
"ended_on": {
"value": "2015-12-08",
"precision": "day"
}
}
],
"metadata": {
"rp_entity_id": "UWCVKI",
"request_id": "<string>",
"timestamp": "<string>"
},
"errors": [
{
"message": "<string>"
}
],
"pagination": {
"cursor": "00000DexaRK4NT6t",
"has_cursor": true
},
"sources": [
{
"id": "CA9FA3",
"name": "Corporate Fundamentals"
}
],
"usage": {}
}{
"message": "Bad Request Error",
"statusCode": 400
}{
"message": "Too many requests. Please try again later.",
"statusCode": 429
}{
"message": "Internal Server Error",
"statusCode": 500
}Private Company People
Returns the people who hold or held a position at one private company: who they are, their title, what kind of position it is, whether they still hold it, and when it started and ended.
One company per request, keyed by RavenPack entity ID. Results are paged: send back
pagination.cursor to get the next page, and keep going until
pagination.has_cursor is false. A company the data provider has no positions for
comes back with an empty results.
curl --request POST \
--url https://api.bigdata.com/v1/private-company-people/query \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"identifier": {
"type": "rp_entity_id",
"value": "UWCVKI"
},
"limit": 100
}
'import requests
url = "https://api.bigdata.com/v1/private-company-people/query"
payload = {
"identifier": {
"type": "rp_entity_id",
"value": "UWCVKI"
},
"limit": 100
}
headers = {
"X-API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({identifier: {type: 'rp_entity_id', value: 'UWCVKI'}, limit: 100})
};
fetch('https://api.bigdata.com/v1/private-company-people/query', 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/v1/private-company-people/query",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'identifier' => [
'type' => 'rp_entity_id',
'value' => 'UWCVKI'
],
'limit' => 100
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.bigdata.com/v1/private-company-people/query"
payload := strings.NewReader("{\n \"identifier\": {\n \"type\": \"rp_entity_id\",\n \"value\": \"UWCVKI\"\n },\n \"limit\": 100\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-KEY", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.bigdata.com/v1/private-company-people/query")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"identifier\": {\n \"type\": \"rp_entity_id\",\n \"value\": \"UWCVKI\"\n },\n \"limit\": 100\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.bigdata.com/v1/private-company-people/query")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"identifier\": {\n \"type\": \"rp_entity_id\",\n \"value\": \"UWCVKI\"\n },\n \"limit\": 100\n}"
response = http.request(request)
puts response.read_body{
"results": [
{
"name": "Sam Altman",
"title": "Co-Founder and CEO",
"role_type": "executive",
"is_current": true,
"started_on": {
"value": "2015-12-08",
"precision": "day"
},
"ended_on": {
"value": "2015-12-08",
"precision": "day"
}
}
],
"metadata": {
"rp_entity_id": "UWCVKI",
"request_id": "<string>",
"timestamp": "<string>"
},
"errors": [
{
"message": "<string>"
}
],
"pagination": {
"cursor": "00000DexaRK4NT6t",
"has_cursor": true
},
"sources": [
{
"id": "CA9FA3",
"name": "Corporate Fundamentals"
}
],
"usage": {}
}{
"message": "Bad Request Error",
"statusCode": 400
}{
"message": "Too many requests. Please try again later.",
"statusCode": 429
}{
"message": "Internal Server Error",
"statusCode": 500
}Authorizations
Body
Object specifying which identifier you are using to request the company profile. You must supply one type and its corresponding value.
Show child attributes
Show child attributes
Positions to return, from 1 to 100.
1 <= x <= 100100
Token for the next page. Send back 'pagination.cursor' from the previous response, unchanged and with the same identifier; 'limit' may differ. Omit it for the first page.
256Response
Successful Response
People who hold or held a position at the company, one entry per position, in the order the data provider lists them. A response holds one page; send pagination.cursor back as cursor for the next. Empty when the provider has no positions for the company.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Common pagination response for endpoints that support pagination.
Show child attributes
Show child attributes
The content catalog sources the response was built from, one entry per source. Empty when no catalog source contributed.
Show child attributes
Show child attributes
Tokens the request consumed, per content tier. Present only for API keys billed in tokens.
Show child attributes
Show child attributes
Was this page helpful?