Skip to main content
POST

Overview

The Buyer Screening API generates a long list of potential buyers for a given target company, enriched with structured data. You can refine the output with a detailed query, sample companies, buyer type, company type, and geography to narrow the strategic criteria. Buyer Screening runs as a workflow. Set workflow to buyer_analysis in the request body to start one. The request returns a report_id, which you then use to track completion and export the results.

Endpoint Details

  • Method: POST
  • Endpoint: /api/workflow_manager/start/

Authentication Requirements

  • Include a valid JWT token in your request header
  • If you don’t have a token yet, you can get one from the /auth/token/ endpoint first.

Request

Header Parameters

string
required
JWT token obtained from the Authentication request

Body Parameters

string
required
The sector or theme describing the target’s business (e.g. "Civil Engineering Infrastructure Services")
string
required
The workflow to run. Must be "buyer_analysis" for Buyer Screening.
string
required
Name of the workbook that will hold the generated buyer list (e.g. "Ulteig Buyers")
object
required
Target and filter parameters object. Include the object in every request, and send empty values ("", []) for any filter you do not want to apply.
string
required
Permalink of the target company or its complete URL (e.g. "ulteig" OR "https://www.ulteig.com/")
string
A descriptive query to refine the buyer search scope and strategic criteria.
string[]
Permalinks of representative companies or their complete URLs to anchor the buyer search.
string[]
Type of buyer to target. Pass an empty array to include all buyer types.Accepted values: "strategic", "financial"
string
Type of company to include. Accepted values: "private", "public", "all"
string[]
Geographic scope. Pass ["Worldwide"] for no geographic restriction, or a list of ISO country codes (e.g. ["USA", "GBR"]).

Response

A successful response returns a report_id that identifies the buyer screening report.

Successful Response Fields

integer
Unique identifier for the report created by this request. Use it to track completion and to download the results (see below).

Tracking Completion and Exporting Results

Buyer Screening generation is asynchronous. After you receive a report_id:
  1. Use /api/assets/get_notebook_status/ to track completion of the report.
  2. Once the report is complete, use /api/assets/download_report/ to export the results.