Search companies
curl --request POST \
--url https://api.stardex.ai/v1/companies/search \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"offset": 0,
"limit": 100,
"sort_by": "<string>",
"sort_order": "desc",
"keywords": [
"<string>"
],
"domain": "<string>",
"linkedin_url": "<string>",
"is_client": true,
"job_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"list_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"company_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"company_status_ids_included": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"company_status_ids_excluded": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"owner_ids_included": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"owner_ids_excluded": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"relationships_included": [
{
"company_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"relationship_type": "<string>"
}
],
"relationships_excluded": [
{
"company_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"relationship_type": "<string>"
}
],
"list_ids_included": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"list_ids_excluded": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"select_attribute_filters": [
{
"attribute_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"values": [],
"excluded_values": [],
"require_all": false,
"include_empty": false
}
],
"numeric_attribute_filters": [
{
"attribute_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"min": 123,
"max": 123,
"include_empty": false
}
],
"date_attribute_filters": [
{
"attribute_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"start_date": "<string>",
"end_date": "<string>",
"include_empty": false
}
],
"team_member_attribute_filters": [
{
"attribute_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"values": [],
"excluded_values": [],
"require_all": false,
"include_empty": false
}
],
"company_attribute_filters": [
{
"attribute_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"values": [],
"excluded_values": [],
"require_all": false,
"include_empty": false
}
],
"include": [
"custom_fields"
]
}
'import requests
url = "https://api.stardex.ai/v1/companies/search"
payload = {
"offset": 0,
"limit": 100,
"sort_by": "<string>",
"sort_order": "desc",
"keywords": ["<string>"],
"domain": "<string>",
"linkedin_url": "<string>",
"is_client": True,
"job_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"list_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"company_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"company_status_ids_included": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"company_status_ids_excluded": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"owner_ids_included": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"owner_ids_excluded": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"relationships_included": [
{
"company_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"relationship_type": "<string>"
}
],
"relationships_excluded": [
{
"company_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"relationship_type": "<string>"
}
],
"list_ids_included": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"list_ids_excluded": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"select_attribute_filters": [
{
"attribute_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"values": [],
"excluded_values": [],
"require_all": False,
"include_empty": False
}
],
"numeric_attribute_filters": [
{
"attribute_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"min": 123,
"max": 123,
"include_empty": False
}
],
"date_attribute_filters": [
{
"attribute_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"start_date": "<string>",
"end_date": "<string>",
"include_empty": False
}
],
"team_member_attribute_filters": [
{
"attribute_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"values": [],
"excluded_values": [],
"require_all": False,
"include_empty": False
}
],
"company_attribute_filters": [
{
"attribute_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"values": [],
"excluded_values": [],
"require_all": False,
"include_empty": False
}
],
"include": ["custom_fields"]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
offset: 0,
limit: 100,
sort_by: '<string>',
sort_order: 'desc',
keywords: ['<string>'],
domain: '<string>',
linkedin_url: '<string>',
is_client: true,
job_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
list_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
company_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
company_status_ids_included: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
company_status_ids_excluded: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
owner_ids_included: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
owner_ids_excluded: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
relationships_included: [
{
company_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
relationship_type: '<string>'
}
],
relationships_excluded: [
{
company_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
relationship_type: '<string>'
}
],
list_ids_included: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
list_ids_excluded: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
select_attribute_filters: [
{
attribute_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
values: [],
excluded_values: [],
require_all: false,
include_empty: false
}
],
numeric_attribute_filters: [
{
attribute_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
min: 123,
max: 123,
include_empty: false
}
],
date_attribute_filters: [
{
attribute_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
start_date: '<string>',
end_date: '<string>',
include_empty: false
}
],
team_member_attribute_filters: [
{
attribute_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
values: [],
excluded_values: [],
require_all: false,
include_empty: false
}
],
company_attribute_filters: [
{
attribute_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
values: [],
excluded_values: [],
require_all: false,
include_empty: false
}
],
include: ['custom_fields']
})
};
fetch('https://api.stardex.ai/v1/companies/search', 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.stardex.ai/v1/companies/search",
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([
'offset' => 0,
'limit' => 100,
'sort_by' => '<string>',
'sort_order' => 'desc',
'keywords' => [
'<string>'
],
'domain' => '<string>',
'linkedin_url' => '<string>',
'is_client' => true,
'job_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'list_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'company_ids' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'company_status_ids_included' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'company_status_ids_excluded' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'owner_ids_included' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'owner_ids_excluded' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'relationships_included' => [
[
'company_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'relationship_type' => '<string>'
]
],
'relationships_excluded' => [
[
'company_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'relationship_type' => '<string>'
]
],
'list_ids_included' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'list_ids_excluded' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'select_attribute_filters' => [
[
'attribute_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'values' => [
],
'excluded_values' => [
],
'require_all' => false,
'include_empty' => false
]
],
'numeric_attribute_filters' => [
[
'attribute_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'min' => 123,
'max' => 123,
'include_empty' => false
]
],
'date_attribute_filters' => [
[
'attribute_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'start_date' => '<string>',
'end_date' => '<string>',
'include_empty' => false
]
],
'team_member_attribute_filters' => [
[
'attribute_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'values' => [
],
'excluded_values' => [
],
'require_all' => false,
'include_empty' => false
]
],
'company_attribute_filters' => [
[
'attribute_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'values' => [
],
'excluded_values' => [
],
'require_all' => false,
'include_empty' => false
]
],
'include' => [
'custom_fields'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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.stardex.ai/v1/companies/search"
payload := strings.NewReader("{\n \"offset\": 0,\n \"limit\": 100,\n \"sort_by\": \"<string>\",\n \"sort_order\": \"desc\",\n \"keywords\": [\n \"<string>\"\n ],\n \"domain\": \"<string>\",\n \"linkedin_url\": \"<string>\",\n \"is_client\": true,\n \"job_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"list_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"company_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"company_status_ids_included\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"company_status_ids_excluded\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"owner_ids_included\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"owner_ids_excluded\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"relationships_included\": [\n {\n \"company_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"relationship_type\": \"<string>\"\n }\n ],\n \"relationships_excluded\": [\n {\n \"company_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"relationship_type\": \"<string>\"\n }\n ],\n \"list_ids_included\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"list_ids_excluded\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"select_attribute_filters\": [\n {\n \"attribute_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"values\": [],\n \"excluded_values\": [],\n \"require_all\": false,\n \"include_empty\": false\n }\n ],\n \"numeric_attribute_filters\": [\n {\n \"attribute_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"min\": 123,\n \"max\": 123,\n \"include_empty\": false\n }\n ],\n \"date_attribute_filters\": [\n {\n \"attribute_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"start_date\": \"<string>\",\n \"end_date\": \"<string>\",\n \"include_empty\": false\n }\n ],\n \"team_member_attribute_filters\": [\n {\n \"attribute_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"values\": [],\n \"excluded_values\": [],\n \"require_all\": false,\n \"include_empty\": false\n }\n ],\n \"company_attribute_filters\": [\n {\n \"attribute_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"values\": [],\n \"excluded_values\": [],\n \"require_all\": false,\n \"include_empty\": false\n }\n ],\n \"include\": [\n \"custom_fields\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.stardex.ai/v1/companies/search")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"offset\": 0,\n \"limit\": 100,\n \"sort_by\": \"<string>\",\n \"sort_order\": \"desc\",\n \"keywords\": [\n \"<string>\"\n ],\n \"domain\": \"<string>\",\n \"linkedin_url\": \"<string>\",\n \"is_client\": true,\n \"job_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"list_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"company_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"company_status_ids_included\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"company_status_ids_excluded\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"owner_ids_included\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"owner_ids_excluded\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"relationships_included\": [\n {\n \"company_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"relationship_type\": \"<string>\"\n }\n ],\n \"relationships_excluded\": [\n {\n \"company_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"relationship_type\": \"<string>\"\n }\n ],\n \"list_ids_included\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"list_ids_excluded\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"select_attribute_filters\": [\n {\n \"attribute_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"values\": [],\n \"excluded_values\": [],\n \"require_all\": false,\n \"include_empty\": false\n }\n ],\n \"numeric_attribute_filters\": [\n {\n \"attribute_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"min\": 123,\n \"max\": 123,\n \"include_empty\": false\n }\n ],\n \"date_attribute_filters\": [\n {\n \"attribute_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"start_date\": \"<string>\",\n \"end_date\": \"<string>\",\n \"include_empty\": false\n }\n ],\n \"team_member_attribute_filters\": [\n {\n \"attribute_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"values\": [],\n \"excluded_values\": [],\n \"require_all\": false,\n \"include_empty\": false\n }\n ],\n \"company_attribute_filters\": [\n {\n \"attribute_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"values\": [],\n \"excluded_values\": [],\n \"require_all\": false,\n \"include_empty\": false\n }\n ],\n \"include\": [\n \"custom_fields\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.stardex.ai/v1/companies/search")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"offset\": 0,\n \"limit\": 100,\n \"sort_by\": \"<string>\",\n \"sort_order\": \"desc\",\n \"keywords\": [\n \"<string>\"\n ],\n \"domain\": \"<string>\",\n \"linkedin_url\": \"<string>\",\n \"is_client\": true,\n \"job_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"list_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"company_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"company_status_ids_included\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"company_status_ids_excluded\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"owner_ids_included\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"owner_ids_excluded\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"relationships_included\": [\n {\n \"company_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"relationship_type\": \"<string>\"\n }\n ],\n \"relationships_excluded\": [\n {\n \"company_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"relationship_type\": \"<string>\"\n }\n ],\n \"list_ids_included\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"list_ids_excluded\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"select_attribute_filters\": [\n {\n \"attribute_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"values\": [],\n \"excluded_values\": [],\n \"require_all\": false,\n \"include_empty\": false\n }\n ],\n \"numeric_attribute_filters\": [\n {\n \"attribute_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"min\": 123,\n \"max\": 123,\n \"include_empty\": false\n }\n ],\n \"date_attribute_filters\": [\n {\n \"attribute_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"start_date\": \"<string>\",\n \"end_date\": \"<string>\",\n \"include_empty\": false\n }\n ],\n \"team_member_attribute_filters\": [\n {\n \"attribute_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"values\": [],\n \"excluded_values\": [],\n \"require_all\": false,\n \"include_empty\": false\n }\n ],\n \"company_attribute_filters\": [\n {\n \"attribute_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"values\": [],\n \"excluded_values\": [],\n \"require_all\": false,\n \"include_empty\": false\n }\n ],\n \"include\": [\n \"custom_fields\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": [
{
"id": "456e7890-e12b-34d5-a678-901234567890",
"name": "Acme Corp",
"domain": "acme.com",
"linkedin_url": "https://www.linkedin.com/company/acme",
"location": "San Francisco, CA",
"is_client": true,
"do_not_contact": true,
"do_not_contact_metadata": {
"reason": "Active client — protect from sourcing",
"do_not_contact_added_by": "234e5678-e90a-12b3-c456-789012345678",
"date_added": "2024-06-01T09:00:00Z",
"last_updated_at": "2024-06-15T14:30:00Z",
"last_updated_by": "234e5678-e90a-12b3-c456-789012345678",
"expiration_date": "2024-09-15T00:00:00Z"
},
"created_at": "2024-01-05T10:00:00Z",
"updated_at": "2024-06-15T14:30:00Z",
"updated_by": {
"id": "234e5678-e90a-12b3-c456-789012345678",
"first_name": "Jane",
"last_name": "Smith"
},
"client_status": {
"id": "789e0123-e45f-67a8-b901-234567890123",
"name": "Active"
},
"date_of_last_engagement": "2024-06-15T14:30:00Z",
"enriched_company": {
"id": "ec123456-7890-abcd-ef01-234567890abc",
"name": "Acme Corp",
"domain": "acme.com",
"linkedin_url": "https://www.linkedin.com/company/acme"
},
"job_target_companies": [],
"owners": [
{
"id": "234e5678-e90a-12b3-c456-789012345678",
"first_name": "Jane",
"last_name": "Smith"
}
],
"relationships": [],
"custom_fields": [
{
"attribute_id": "e5f6a7b8-c9d0-1234-efab-567890123456",
"attribute_name": "Industry",
"data_type": "single-select",
"value": null,
"tag": {
"id": "f6a7b8c9-d0e1-2345-fabc-678901234567",
"name": "Technology"
},
"team_member": null,
"company": null
}
]
}
],
"meta": {
"total": 42,
"offset": 0,
"limit": 100
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}Companies
Search companies
Advanced company search with filtering, sorting, and custom attribute filters.
Filters: keywords (name/domain/LinkedIn), exact domain, exact linkedin_url, is_client, company_status_ids_included/excluded, owner_ids_included/excluded, relationships_included/excluded, list_ids_included/excluded, job_id, company_ids.
Custom attribute filters: select_attribute_filters, numeric_attribute_filters, date_attribute_filters, team_member_attribute_filters, company_attribute_filters. Get attribute IDs and tag IDs from GET /v1/custom-fields/companies.
Sorting: Pass sort_by with one of: name, domain, status (client status stage order), date_of_last_engagement, created_at (default), or custom_<attribute_id> for any custom field. Pair with sort_order (asc or desc, default desc).
Include control: Pass include: ["custom_fields"] to embed custom field values in each result.
POST
/
v1
/
companies
/
search
Search companies
curl --request POST \
--url https://api.stardex.ai/v1/companies/search \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"offset": 0,
"limit": 100,
"sort_by": "<string>",
"sort_order": "desc",
"keywords": [
"<string>"
],
"domain": "<string>",
"linkedin_url": "<string>",
"is_client": true,
"job_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"list_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"company_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"company_status_ids_included": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"company_status_ids_excluded": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"owner_ids_included": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"owner_ids_excluded": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"relationships_included": [
{
"company_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"relationship_type": "<string>"
}
],
"relationships_excluded": [
{
"company_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"relationship_type": "<string>"
}
],
"list_ids_included": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"list_ids_excluded": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"select_attribute_filters": [
{
"attribute_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"values": [],
"excluded_values": [],
"require_all": false,
"include_empty": false
}
],
"numeric_attribute_filters": [
{
"attribute_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"min": 123,
"max": 123,
"include_empty": false
}
],
"date_attribute_filters": [
{
"attribute_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"start_date": "<string>",
"end_date": "<string>",
"include_empty": false
}
],
"team_member_attribute_filters": [
{
"attribute_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"values": [],
"excluded_values": [],
"require_all": false,
"include_empty": false
}
],
"company_attribute_filters": [
{
"attribute_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"values": [],
"excluded_values": [],
"require_all": false,
"include_empty": false
}
],
"include": [
"custom_fields"
]
}
'import requests
url = "https://api.stardex.ai/v1/companies/search"
payload = {
"offset": 0,
"limit": 100,
"sort_by": "<string>",
"sort_order": "desc",
"keywords": ["<string>"],
"domain": "<string>",
"linkedin_url": "<string>",
"is_client": True,
"job_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"list_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"company_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"company_status_ids_included": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"company_status_ids_excluded": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"owner_ids_included": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"owner_ids_excluded": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"relationships_included": [
{
"company_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"relationship_type": "<string>"
}
],
"relationships_excluded": [
{
"company_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"relationship_type": "<string>"
}
],
"list_ids_included": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"list_ids_excluded": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"select_attribute_filters": [
{
"attribute_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"values": [],
"excluded_values": [],
"require_all": False,
"include_empty": False
}
],
"numeric_attribute_filters": [
{
"attribute_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"min": 123,
"max": 123,
"include_empty": False
}
],
"date_attribute_filters": [
{
"attribute_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"start_date": "<string>",
"end_date": "<string>",
"include_empty": False
}
],
"team_member_attribute_filters": [
{
"attribute_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"values": [],
"excluded_values": [],
"require_all": False,
"include_empty": False
}
],
"company_attribute_filters": [
{
"attribute_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"values": [],
"excluded_values": [],
"require_all": False,
"include_empty": False
}
],
"include": ["custom_fields"]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
offset: 0,
limit: 100,
sort_by: '<string>',
sort_order: 'desc',
keywords: ['<string>'],
domain: '<string>',
linkedin_url: '<string>',
is_client: true,
job_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
list_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
company_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
company_status_ids_included: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
company_status_ids_excluded: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
owner_ids_included: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
owner_ids_excluded: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
relationships_included: [
{
company_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
relationship_type: '<string>'
}
],
relationships_excluded: [
{
company_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
relationship_type: '<string>'
}
],
list_ids_included: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
list_ids_excluded: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
select_attribute_filters: [
{
attribute_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
values: [],
excluded_values: [],
require_all: false,
include_empty: false
}
],
numeric_attribute_filters: [
{
attribute_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
min: 123,
max: 123,
include_empty: false
}
],
date_attribute_filters: [
{
attribute_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
start_date: '<string>',
end_date: '<string>',
include_empty: false
}
],
team_member_attribute_filters: [
{
attribute_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
values: [],
excluded_values: [],
require_all: false,
include_empty: false
}
],
company_attribute_filters: [
{
attribute_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
values: [],
excluded_values: [],
require_all: false,
include_empty: false
}
],
include: ['custom_fields']
})
};
fetch('https://api.stardex.ai/v1/companies/search', 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.stardex.ai/v1/companies/search",
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([
'offset' => 0,
'limit' => 100,
'sort_by' => '<string>',
'sort_order' => 'desc',
'keywords' => [
'<string>'
],
'domain' => '<string>',
'linkedin_url' => '<string>',
'is_client' => true,
'job_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'list_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'company_ids' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'company_status_ids_included' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'company_status_ids_excluded' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'owner_ids_included' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'owner_ids_excluded' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'relationships_included' => [
[
'company_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'relationship_type' => '<string>'
]
],
'relationships_excluded' => [
[
'company_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'relationship_type' => '<string>'
]
],
'list_ids_included' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'list_ids_excluded' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'select_attribute_filters' => [
[
'attribute_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'values' => [
],
'excluded_values' => [
],
'require_all' => false,
'include_empty' => false
]
],
'numeric_attribute_filters' => [
[
'attribute_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'min' => 123,
'max' => 123,
'include_empty' => false
]
],
'date_attribute_filters' => [
[
'attribute_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'start_date' => '<string>',
'end_date' => '<string>',
'include_empty' => false
]
],
'team_member_attribute_filters' => [
[
'attribute_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'values' => [
],
'excluded_values' => [
],
'require_all' => false,
'include_empty' => false
]
],
'company_attribute_filters' => [
[
'attribute_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'values' => [
],
'excluded_values' => [
],
'require_all' => false,
'include_empty' => false
]
],
'include' => [
'custom_fields'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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.stardex.ai/v1/companies/search"
payload := strings.NewReader("{\n \"offset\": 0,\n \"limit\": 100,\n \"sort_by\": \"<string>\",\n \"sort_order\": \"desc\",\n \"keywords\": [\n \"<string>\"\n ],\n \"domain\": \"<string>\",\n \"linkedin_url\": \"<string>\",\n \"is_client\": true,\n \"job_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"list_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"company_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"company_status_ids_included\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"company_status_ids_excluded\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"owner_ids_included\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"owner_ids_excluded\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"relationships_included\": [\n {\n \"company_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"relationship_type\": \"<string>\"\n }\n ],\n \"relationships_excluded\": [\n {\n \"company_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"relationship_type\": \"<string>\"\n }\n ],\n \"list_ids_included\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"list_ids_excluded\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"select_attribute_filters\": [\n {\n \"attribute_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"values\": [],\n \"excluded_values\": [],\n \"require_all\": false,\n \"include_empty\": false\n }\n ],\n \"numeric_attribute_filters\": [\n {\n \"attribute_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"min\": 123,\n \"max\": 123,\n \"include_empty\": false\n }\n ],\n \"date_attribute_filters\": [\n {\n \"attribute_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"start_date\": \"<string>\",\n \"end_date\": \"<string>\",\n \"include_empty\": false\n }\n ],\n \"team_member_attribute_filters\": [\n {\n \"attribute_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"values\": [],\n \"excluded_values\": [],\n \"require_all\": false,\n \"include_empty\": false\n }\n ],\n \"company_attribute_filters\": [\n {\n \"attribute_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"values\": [],\n \"excluded_values\": [],\n \"require_all\": false,\n \"include_empty\": false\n }\n ],\n \"include\": [\n \"custom_fields\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.stardex.ai/v1/companies/search")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"offset\": 0,\n \"limit\": 100,\n \"sort_by\": \"<string>\",\n \"sort_order\": \"desc\",\n \"keywords\": [\n \"<string>\"\n ],\n \"domain\": \"<string>\",\n \"linkedin_url\": \"<string>\",\n \"is_client\": true,\n \"job_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"list_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"company_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"company_status_ids_included\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"company_status_ids_excluded\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"owner_ids_included\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"owner_ids_excluded\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"relationships_included\": [\n {\n \"company_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"relationship_type\": \"<string>\"\n }\n ],\n \"relationships_excluded\": [\n {\n \"company_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"relationship_type\": \"<string>\"\n }\n ],\n \"list_ids_included\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"list_ids_excluded\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"select_attribute_filters\": [\n {\n \"attribute_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"values\": [],\n \"excluded_values\": [],\n \"require_all\": false,\n \"include_empty\": false\n }\n ],\n \"numeric_attribute_filters\": [\n {\n \"attribute_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"min\": 123,\n \"max\": 123,\n \"include_empty\": false\n }\n ],\n \"date_attribute_filters\": [\n {\n \"attribute_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"start_date\": \"<string>\",\n \"end_date\": \"<string>\",\n \"include_empty\": false\n }\n ],\n \"team_member_attribute_filters\": [\n {\n \"attribute_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"values\": [],\n \"excluded_values\": [],\n \"require_all\": false,\n \"include_empty\": false\n }\n ],\n \"company_attribute_filters\": [\n {\n \"attribute_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"values\": [],\n \"excluded_values\": [],\n \"require_all\": false,\n \"include_empty\": false\n }\n ],\n \"include\": [\n \"custom_fields\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.stardex.ai/v1/companies/search")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"offset\": 0,\n \"limit\": 100,\n \"sort_by\": \"<string>\",\n \"sort_order\": \"desc\",\n \"keywords\": [\n \"<string>\"\n ],\n \"domain\": \"<string>\",\n \"linkedin_url\": \"<string>\",\n \"is_client\": true,\n \"job_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"list_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"company_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"company_status_ids_included\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"company_status_ids_excluded\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"owner_ids_included\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"owner_ids_excluded\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"relationships_included\": [\n {\n \"company_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"relationship_type\": \"<string>\"\n }\n ],\n \"relationships_excluded\": [\n {\n \"company_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"relationship_type\": \"<string>\"\n }\n ],\n \"list_ids_included\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"list_ids_excluded\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"select_attribute_filters\": [\n {\n \"attribute_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"values\": [],\n \"excluded_values\": [],\n \"require_all\": false,\n \"include_empty\": false\n }\n ],\n \"numeric_attribute_filters\": [\n {\n \"attribute_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"min\": 123,\n \"max\": 123,\n \"include_empty\": false\n }\n ],\n \"date_attribute_filters\": [\n {\n \"attribute_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"start_date\": \"<string>\",\n \"end_date\": \"<string>\",\n \"include_empty\": false\n }\n ],\n \"team_member_attribute_filters\": [\n {\n \"attribute_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"values\": [],\n \"excluded_values\": [],\n \"require_all\": false,\n \"include_empty\": false\n }\n ],\n \"company_attribute_filters\": [\n {\n \"attribute_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"values\": [],\n \"excluded_values\": [],\n \"require_all\": false,\n \"include_empty\": false\n }\n ],\n \"include\": [\n \"custom_fields\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": [
{
"id": "456e7890-e12b-34d5-a678-901234567890",
"name": "Acme Corp",
"domain": "acme.com",
"linkedin_url": "https://www.linkedin.com/company/acme",
"location": "San Francisco, CA",
"is_client": true,
"do_not_contact": true,
"do_not_contact_metadata": {
"reason": "Active client — protect from sourcing",
"do_not_contact_added_by": "234e5678-e90a-12b3-c456-789012345678",
"date_added": "2024-06-01T09:00:00Z",
"last_updated_at": "2024-06-15T14:30:00Z",
"last_updated_by": "234e5678-e90a-12b3-c456-789012345678",
"expiration_date": "2024-09-15T00:00:00Z"
},
"created_at": "2024-01-05T10:00:00Z",
"updated_at": "2024-06-15T14:30:00Z",
"updated_by": {
"id": "234e5678-e90a-12b3-c456-789012345678",
"first_name": "Jane",
"last_name": "Smith"
},
"client_status": {
"id": "789e0123-e45f-67a8-b901-234567890123",
"name": "Active"
},
"date_of_last_engagement": "2024-06-15T14:30:00Z",
"enriched_company": {
"id": "ec123456-7890-abcd-ef01-234567890abc",
"name": "Acme Corp",
"domain": "acme.com",
"linkedin_url": "https://www.linkedin.com/company/acme"
},
"job_target_companies": [],
"owners": [
{
"id": "234e5678-e90a-12b3-c456-789012345678",
"first_name": "Jane",
"last_name": "Smith"
}
],
"relationships": [],
"custom_fields": [
{
"attribute_id": "e5f6a7b8-c9d0-1234-efab-567890123456",
"attribute_name": "Industry",
"data_type": "single-select",
"value": null,
"tag": {
"id": "f6a7b8c9-d0e1-2345-fabc-678901234567",
"name": "Technology"
},
"team_member": null,
"company": null
}
]
}
],
"meta": {
"total": 42,
"offset": 0,
"limit": 100
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}Authorizations
Authenticate with a Bearer token: API key, OAuth token, or session token.
Body
application/json
Records to skip for pagination. Defaults to 0.
Required range:
x >= 0Max records to return (1–100). Defaults to 100.
Required range:
1 <= x <= 100Column to sort by. Accepted values:
name— company name (alphabetical)domain— website domain (alphabetical)status— client status (by stage order)date_of_last_engagement— most recent engagement datecreated_at— creation timestamp (default)custom_<attribute_id>— any custom attribute UUID prefixed withcustom_(e.g.custom_e5f6a7b8-c9d0-1234-efab-567890123456). Sorts by the attribute's decimal, date, string, or tag value.
Sort direction. Defaults to desc (newest first).
Available options:
asc, desc Full-text search across company name, domain, and LinkedIn URL.
Filter by exact website domain (e.g. "acme.com").
Filter by exact LinkedIn company URL.
Filter by client status. true = clients only, false = non-clients, omit = all.
Filter to target companies of this job.
Filter to companies belonging to this list.
Pre-filter to a specific set of company IDs.
Include only companies with these client status IDs.
Exclude companies with these client status IDs.
Include only companies owned by these team members. Get IDs from GET /v1/team-members.
Exclude companies owned by these team members.
Include only companies with a relationship to any of these companies.
Show child attributes
Show child attributes
Exclude companies with a relationship to these companies.
Show child attributes
Show child attributes
Include companies belonging to any of these lists.
Exclude companies belonging to any of these lists.
Filter by job association. "has_jobs" returns companies with at least one non-deleted job. "no_jobs" returns companies with no jobs.
Available options:
has_jobs, no_jobs When job_association is "has_jobs", further filter by job status. "active_or_archived" (default) matches any non-deleted job. "active_only" matches companies with at least one active (non-archived) job. "archived_only" matches companies that only have archived jobs (no active ones).
Available options:
active_or_archived, active_only, archived_only Filter by select/multi-select custom fields. Get attribute_id and tag IDs from GET /v1/custom-fields/companies.
Show child attributes
Show child attributes
Filter by numeric custom fields (min/max range). Get attribute_id from GET /v1/custom-fields/companies.
Show child attributes
Show child attributes
Filter by date custom fields (date range). Get attribute_id from GET /v1/custom-fields/companies.
Show child attributes
Show child attributes
Filter by team-member custom fields. Get attribute_id from GET /v1/custom-fields/companies.
Show child attributes
Show child attributes
Filter by multi-company custom fields. Get attribute_id from GET /v1/custom-fields/companies.
Show child attributes
Show child attributes
Extra sections to embed. Values: custom_fields. Omit for base fields only.
Available options:
custom_fields Was this page helpful?