Skip to main content
GET
Get search criteria

Overview

This endpoint retrieves the search criteria that was used to discover companies for a specific market.
Workflow Step: This is part of Phase 3 (Company Review) of the Market Research Workflow.

Usage

Use this endpoint to review the search criteria that was used for discovery, which is helpful for:
  • Iteration: Understanding what criteria led to the current results
  • Documentation: Keeping track of search parameters used

Best Practices

Review Process: This endpoint is particularly useful during the company review phase to understand what criteria led to the discovered companies.
Important: This endpoint only works for markets that have completed the discovery process. Make sure discovery is finished before calling this endpoint.

Authorizations

x-api-key
string
header
required

Pass a static API key for every request, provided by your customer support.

Path Parameters

marketId
integer
required

Unique identifier for the market study.

Required range: x > 0

Response

Search criteria retrieved

metadata
object
required
data
object
required