Skip to main content
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
    }
  ],
  "include": [
    "custom_fields"
  ]
}
'
{
  "success": true,
  "data": [
    {
      "id": "456e7890-e12b-34d5-a678-901234567890",
      "name": "Acme Corp",
      "domain": "acme.com",
      "linkedin_url": "https://www.linkedin.com/company/acme",
      "is_client": true,
      "do_not_contact": false,
      "do_not_contact_metadata": null,
      "created_at": "2024-01-05T10:00:00Z",
      "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",
          "image_url": null
        }
      ],
      "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
        }
      ]
    }
  ],
  "meta": {
    "total": 42,
    "offset": 0,
    "limit": 100
  }
}

Authorizations

​
Authorization
string
header
required

Authenticate with a Bearer token: API key, OAuth token, or session token.

Body

application/json
​
offset
integer
default:0

Records to skip for pagination. Defaults to 0.

Required range: x >= 0
​
limit
integer
default:100

Max records to return (1–100). Defaults to 100.

Required range: 1 <= x <= 100
​
sort_by
string

Column 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 date
  • created_at — creation timestamp (default)
  • custom_<attribute_id> — any custom attribute UUID prefixed with custom_ (e.g. custom_e5f6a7b8-c9d0-1234-efab-567890123456). Sorts by the attribute's decimal, date, string, or tag value.
​
sort_order
enum<string>
default:desc

Sort direction. Defaults to desc (newest first).

Available options:
asc,
desc
​
keywords
string[]

Full-text search across company name, domain, and LinkedIn URL.

​
domain
string

Filter by exact website domain (e.g. "acme.com").

​
linkedin_url
string

Filter by exact LinkedIn company URL.

​
is_client
boolean

Filter by client status. true = clients only, false = non-clients, omit = all.

​
job_id
string<uuid>

Filter to target companies of this job.

​
list_id
string<uuid>

Filter to companies belonging to this list.

​
company_ids
string<uuid>[]

Pre-filter to a specific set of company IDs.

​
company_status_ids_included
string<uuid>[]

Include only companies with these client status IDs.

​
company_status_ids_excluded
string<uuid>[]

Exclude companies with these client status IDs.

​
owner_ids_included
string<uuid>[]

Include only companies owned by these team members. Get IDs from GET /v1/team-members.

​
owner_ids_excluded
string<uuid>[]

Exclude companies owned by these team members.

​
relationships_included
object[]

Include only companies with a relationship to any of these companies.

​
relationships_excluded
object[]

Exclude companies with a relationship to these companies.

​
list_ids_included
string<uuid>[]

Include companies belonging to any of these lists.

​
list_ids_excluded
string<uuid>[]

Exclude companies belonging to any of these lists.

​
select_attribute_filters
object[]

Filter by select/multi-select custom fields. Get attribute_id and tag IDs from GET /v1/custom-fields/companies.

​
numeric_attribute_filters
object[]

Filter by numeric custom fields (min/max range). Get attribute_id from GET /v1/custom-fields/companies.

​
date_attribute_filters
object[]

Filter by date custom fields (date range). Get attribute_id from GET /v1/custom-fields/companies.

​
team_member_attribute_filters
object[]

Filter by team-member custom fields. Get attribute_id from GET /v1/custom-fields/companies.

​
include
enum<string>[]

Extra sections to embed. Values: custom_fields. Omit for base fields only.

Available options:
custom_fields

Response

Companies found

​
success
enum<boolean>
required
Available options:
true
​
data
object[]
required
​
meta
object
required