Authentication Method

SMARTe supports the following authentication mechanism:

API Key authentication for secure access across all Discover APIs.

Select an Endpoint

Choose the API based on the type of data required:

Endpoint	Description
/v2/discover/person	Returns person-level records based on applied filters
/v2/discover/company	Returns company-level records using firmographic filters
/v2/discover/stats	Returns aggregated insights such as counts and distributions

Define Your Filters

Discover APIs use a structured filtering framework to retrieve relevant data.

Multiple filters can be applied together to refine results
Each filter can accept one or more values
Selected filters support List of Values (LoV) for standardized inputs
LoV details are available on request via [email protected]

Both person and company filters can be used together. When company filters are applied in person discovery, the response continues to return person-level records.

Select Mode (Person and Company APIs)

Person and Company Discover APIs support the following modes:

Mode	Description
Preview	Returns a limited dataset for validation and is not charged
All	Returns complete datasets and is charged as per credit usage policies

Send Your First API Request

Sample request using the Person Discover API:

curl --request POST \
  --url https://api.smarte.pro/v8/discover/person \
  --header 'apikey: <key>' \
  --header 'Content-Type: application/json' \
  --header 'output-mode: preview' \
  --data '{
    "filters": {
      "jobTitles": ["Marketing Manager", "Sales Director"],
      "companyCountry": ["United States"]
    }
  }'

Review the Response

Each response includes:

Matching records based on applied filters
Data fields based on available values (empty fields are not returned)
A smarteTransactionId for tracking

Stats API

The Stats API provides aggregated insights and is used for analysis before retrieving actual records.

Returns counts and distributions instead of raw data
Supports both person and company filters in the same request
Includes Counts output, which provides total matching record volume for given filters
No credits are deducted for Stats API usage

Common Workflows

The Discover APIs support multiple real-world workflows:

1. Audience Sizing

Use the Stats API (Counts) to understand how many records match specific criteria before retrieving data.

2. Data Exploration

Use Preview mode in Person or Company APIs to validate filters and review sample results without credit usage.

3. Full Data Retrieval

Use All mode to retrieve complete datasets once filters are finalized.

4. Suppression-based Filtering

Apply suppression filters during bulk workflows to exclude specific records.

Suppression lists are created using Suppression APIs
Each list generates a listId
These listIds can be used as filters in Discover or downstream workflows to exclude records.

Getting Started