Company Preview
curl --request POST \
--url https://api.revenuebase.ai/v2/contact/company/preview \
--header 'Content-Type: application/json' \
--header 'X-Key: <api-key>' \
--data '
{
"filter": {
"type": "group",
"op": "AND",
"children": [
{
"type": "condition",
"column": "HEADQUARTERS_COUNTRY_NAME_ORG",
"operator": "eq",
"value": "United States"
}
]
},
"columns": [
"RBID_ORG",
"COMPANY_NAME_ORG",
"DOMAIN_ORG"
],
"limit": 2
}
'import requests
url = "https://api.revenuebase.ai/v2/contact/company/preview"
payload = {
"filter": {
"type": "group",
"op": "AND",
"children": [
{
"type": "condition",
"column": "HEADQUARTERS_COUNTRY_NAME_ORG",
"operator": "eq",
"value": "United States"
}
]
},
"columns": ["RBID_ORG", "COMPANY_NAME_ORG", "DOMAIN_ORG"],
"limit": 2
}
headers = {
"X-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
filter: {
type: 'group',
op: 'AND',
children: [
{
type: 'condition',
column: 'HEADQUARTERS_COUNTRY_NAME_ORG',
operator: 'eq',
value: 'United States'
}
]
},
columns: ['RBID_ORG', 'COMPANY_NAME_ORG', 'DOMAIN_ORG'],
limit: 2
})
};
fetch('https://api.revenuebase.ai/v2/contact/company/preview', 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.revenuebase.ai/v2/contact/company/preview",
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([
'filter' => [
'type' => 'group',
'op' => 'AND',
'children' => [
[
'type' => 'condition',
'column' => 'HEADQUARTERS_COUNTRY_NAME_ORG',
'operator' => 'eq',
'value' => 'United States'
]
]
],
'columns' => [
'RBID_ORG',
'COMPANY_NAME_ORG',
'DOMAIN_ORG'
],
'limit' => 2
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-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.revenuebase.ai/v2/contact/company/preview"
payload := strings.NewReader("{\n \"filter\": {\n \"type\": \"group\",\n \"op\": \"AND\",\n \"children\": [\n {\n \"type\": \"condition\",\n \"column\": \"HEADQUARTERS_COUNTRY_NAME_ORG\",\n \"operator\": \"eq\",\n \"value\": \"United States\"\n }\n ]\n },\n \"columns\": [\n \"RBID_ORG\",\n \"COMPANY_NAME_ORG\",\n \"DOMAIN_ORG\"\n ],\n \"limit\": 2\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-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.revenuebase.ai/v2/contact/company/preview")
.header("X-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"filter\": {\n \"type\": \"group\",\n \"op\": \"AND\",\n \"children\": [\n {\n \"type\": \"condition\",\n \"column\": \"HEADQUARTERS_COUNTRY_NAME_ORG\",\n \"operator\": \"eq\",\n \"value\": \"United States\"\n }\n ]\n },\n \"columns\": [\n \"RBID_ORG\",\n \"COMPANY_NAME_ORG\",\n \"DOMAIN_ORG\"\n ],\n \"limit\": 2\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.revenuebase.ai/v2/contact/company/preview")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"filter\": {\n \"type\": \"group\",\n \"op\": \"AND\",\n \"children\": [\n {\n \"type\": \"condition\",\n \"column\": \"HEADQUARTERS_COUNTRY_NAME_ORG\",\n \"operator\": \"eq\",\n \"value\": \"United States\"\n }\n ]\n },\n \"columns\": [\n \"RBID_ORG\",\n \"COMPANY_NAME_ORG\",\n \"DOMAIN_ORG\"\n ],\n \"limit\": 2\n}"
response = http.request(request)
puts response.read_body{
"rows": [
{
"RBID_ORG": "rb-oacrey5u7",
"COMPANY_NAME_ORG": "Bike Mart",
"DOMAIN_ORG": "bikemart.com"
},
{
"RBID_ORG": "rb-oacrey7is",
"COMPANY_NAME_ORG": "Fashion After 50.Com",
"DOMAIN_ORG": null
}
],
"columns": [
"RBID_ORG",
"COMPANY_NAME_ORG",
"DOMAIN_ORG"
],
"columnLabels": {
"RBID_ORG": "Rbid Organization",
"COMPANY_NAME_ORG": "Company Name",
"DOMAIN_ORG": "Organization Domain"
},
"rowCount": 2,
"limit": 2
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Company Endpoints
Company Preview
Return matching company records directly in the API response.
POST
/
company
/
preview
Company Preview
curl --request POST \
--url https://api.revenuebase.ai/v2/contact/company/preview \
--header 'Content-Type: application/json' \
--header 'X-Key: <api-key>' \
--data '
{
"filter": {
"type": "group",
"op": "AND",
"children": [
{
"type": "condition",
"column": "HEADQUARTERS_COUNTRY_NAME_ORG",
"operator": "eq",
"value": "United States"
}
]
},
"columns": [
"RBID_ORG",
"COMPANY_NAME_ORG",
"DOMAIN_ORG"
],
"limit": 2
}
'import requests
url = "https://api.revenuebase.ai/v2/contact/company/preview"
payload = {
"filter": {
"type": "group",
"op": "AND",
"children": [
{
"type": "condition",
"column": "HEADQUARTERS_COUNTRY_NAME_ORG",
"operator": "eq",
"value": "United States"
}
]
},
"columns": ["RBID_ORG", "COMPANY_NAME_ORG", "DOMAIN_ORG"],
"limit": 2
}
headers = {
"X-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
filter: {
type: 'group',
op: 'AND',
children: [
{
type: 'condition',
column: 'HEADQUARTERS_COUNTRY_NAME_ORG',
operator: 'eq',
value: 'United States'
}
]
},
columns: ['RBID_ORG', 'COMPANY_NAME_ORG', 'DOMAIN_ORG'],
limit: 2
})
};
fetch('https://api.revenuebase.ai/v2/contact/company/preview', 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.revenuebase.ai/v2/contact/company/preview",
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([
'filter' => [
'type' => 'group',
'op' => 'AND',
'children' => [
[
'type' => 'condition',
'column' => 'HEADQUARTERS_COUNTRY_NAME_ORG',
'operator' => 'eq',
'value' => 'United States'
]
]
],
'columns' => [
'RBID_ORG',
'COMPANY_NAME_ORG',
'DOMAIN_ORG'
],
'limit' => 2
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-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.revenuebase.ai/v2/contact/company/preview"
payload := strings.NewReader("{\n \"filter\": {\n \"type\": \"group\",\n \"op\": \"AND\",\n \"children\": [\n {\n \"type\": \"condition\",\n \"column\": \"HEADQUARTERS_COUNTRY_NAME_ORG\",\n \"operator\": \"eq\",\n \"value\": \"United States\"\n }\n ]\n },\n \"columns\": [\n \"RBID_ORG\",\n \"COMPANY_NAME_ORG\",\n \"DOMAIN_ORG\"\n ],\n \"limit\": 2\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-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.revenuebase.ai/v2/contact/company/preview")
.header("X-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"filter\": {\n \"type\": \"group\",\n \"op\": \"AND\",\n \"children\": [\n {\n \"type\": \"condition\",\n \"column\": \"HEADQUARTERS_COUNTRY_NAME_ORG\",\n \"operator\": \"eq\",\n \"value\": \"United States\"\n }\n ]\n },\n \"columns\": [\n \"RBID_ORG\",\n \"COMPANY_NAME_ORG\",\n \"DOMAIN_ORG\"\n ],\n \"limit\": 2\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.revenuebase.ai/v2/contact/company/preview")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"filter\": {\n \"type\": \"group\",\n \"op\": \"AND\",\n \"children\": [\n {\n \"type\": \"condition\",\n \"column\": \"HEADQUARTERS_COUNTRY_NAME_ORG\",\n \"operator\": \"eq\",\n \"value\": \"United States\"\n }\n ]\n },\n \"columns\": [\n \"RBID_ORG\",\n \"COMPANY_NAME_ORG\",\n \"DOMAIN_ORG\"\n ],\n \"limit\": 2\n}"
response = http.request(request)
puts response.read_body{
"rows": [
{
"RBID_ORG": "rb-oacrey5u7",
"COMPANY_NAME_ORG": "Bike Mart",
"DOMAIN_ORG": "bikemart.com"
},
{
"RBID_ORG": "rb-oacrey7is",
"COMPANY_NAME_ORG": "Fashion After 50.Com",
"DOMAIN_ORG": null
}
],
"columns": [
"RBID_ORG",
"COMPANY_NAME_ORG",
"DOMAIN_ORG"
],
"columnLabels": {
"RBID_ORG": "Rbid Organization",
"COMPANY_NAME_ORG": "Company Name",
"DOMAIN_ORG": "Organization Domain"
},
"rowCount": 2,
"limit": 2
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Credits and plans
PAYG is Pay-as-you-go. AYCE is All-you-can-eat.| Usage | PAYG | AYCE |
|---|---|---|
| Company records, current behavior | Free 0 credits | Unlimited 0 credits |
| Rows per request | 50,000 maximum | 50,000 maximum |
RBID_ORG. If you need company fields alongside individual people, contact records already include their available company data; requesting those fields does not add a separate company-row charge.
When to use Company Preview
Inspect a company list or retrieve an immediate batch of company records. For a downloadable file or a company audience selected through contact criteria, choose Company Export.Example
SetREVENUEBASE_API_KEY to your API key.
curl --request POST 'https://api.revenuebase.ai/v2/contact/company/preview' \
--header "X-Key: $REVENUEBASE_API_KEY" \
--header 'Content-Type: application/json' \
--data '{
"filter": {
"type": "group",
"op": "AND",
"children": [
{
"type": "condition",
"column": "HEADQUARTERS_COUNTRY_NAME_ORG",
"operator": "eq",
"value": "United States"
}
]
},
"columns": [
"RBID_ORG",
"COMPANY_NAME_ORG",
"DOMAIN_ORG"
],
"limit": 2
}'
{
"rows": [
{
"RBID_ORG": "rb-oacrey5u7",
"COMPANY_NAME_ORG": "Bike Mart",
"DOMAIN_ORG": "bikemart.com"
},
{
"RBID_ORG": "rb-oacrey7is",
"COMPANY_NAME_ORG": "Fashion After 50.Com",
"DOMAIN_ORG": null
}
],
"columns": [
"RBID_ORG",
"COMPANY_NAME_ORG",
"DOMAIN_ORG"
],
"columnLabels": {
"RBID_ORG": "Rbid Organization",
"COMPANY_NAME_ORG": "Company Name",
"DOMAIN_ORG": "Organization Domain"
},
"rowCount": 2,
"limit": 2
}
Read the response
rows contains company objects. rowCount reports how many were returned; limit is the applied row cap. columns and columnLabels identify the returned fields. The list can be shorter than the limit. There is no pagination cursor or guaranteed order for ordinary requests.
Options and limits
| Option | Use it for |
|---|---|
filter | Company criteria, including company-description SmartSearch or a company lookalike filter. Person and job conditions are unsupported here. |
columns | Select company fields; omitted or empty uses the company defaults. ["*"] returns all company catalog fields. |
limit | 1,000 by default, clamped to 1 through 50,000. Choose a small explicit limit to inspect results. |
includeScores | Add available SmartSearch similarity details. Scores can be omitted with scoresOmitted=true. |
reveal | Accepted for compatibility; does not control company fields or apply contact email/mobile pricing. |
Errors and retries
Correct unsupported fields or filters before retrying a 400 or 422 response. If a 429 response is returned, wait for Retry-After. Contact and company routes share the default 10 requests per second per user.Next steps
Company Insights summarizes this audience. Company Enrich retrieves known company identifiers; Company Export creates a file.Authorizations
Body
application/json
Company conditions only. Use Company Count and Export for company audiences selected by person or job criteria.
Show child attributes
Show child attributes
Company fields to return. Omitted or empty uses company defaults; ["*"] expands to the company catalog.
Maximum rows requested; 1,000 default, clamped to 1 through 50,000.
Add available SmartSearch similarity scores; the response can report scoresOmitted.
Accepted for compatibility and ignored for company data; no contact email/mobile masking is applied.
Response
Successful Response
The response is of type Response Company Preview V1 Company Preview Post · object.
Was this page helpful?
