{
"topic": "Civil Engineering Infrastructure Services",
"workflow": "buyer_analysis",
"workbook_name": "Ulteig Buyers",
"advanced_settings": {
"target": "ulteig",
"detailed_query": "Civil Engineering Infrastructure Services",
"companies": [],
"buyer_type": [],
"company_type": "all",
"geography": ["Worldwide"]
}
}
{
"topic": "Civil Engineering Infrastructure Services",
"workflow": "buyer_analysis",
"workbook_name": "Ulteig Buyers",
"advanced_settings": {
"target": "ulteig",
"detailed_query": "Engineering and consulting firms seeking to expand infrastructure services",
"companies": [],
"buyer_type": ["strategic"],
"company_type": "public",
"geography": ["USA", "CAN"]
}
}
{
"report_id": 117253
}
Discovery
Buyer Screening
POST
/
api
/
workflow_manager
/
start
/
{
"topic": "Civil Engineering Infrastructure Services",
"workflow": "buyer_analysis",
"workbook_name": "Ulteig Buyers",
"advanced_settings": {
"target": "ulteig",
"detailed_query": "Civil Engineering Infrastructure Services",
"companies": [],
"buyer_type": [],
"company_type": "all",
"geography": ["Worldwide"]
}
}
{
"topic": "Civil Engineering Infrastructure Services",
"workflow": "buyer_analysis",
"workbook_name": "Ulteig Buyers",
"advanced_settings": {
"target": "ulteig",
"detailed_query": "Engineering and consulting firms seeking to expand infrastructure services",
"companies": [],
"buyer_type": ["strategic"],
"company_type": "public",
"geography": ["USA", "CAN"]
}
}
{
"report_id": 117253
}
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. Setworkflow 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
Body Parameters
The sector or theme describing the target’s business (e.g.
"Civil Engineering Infrastructure Services")Target and filter parameters object. Include the object in every request, and send empty values (
"", []) for any filter you do not want to apply.Permalink of the target company or its complete URL (e.g.
"ulteig" OR "https://www.ulteig.com/")Type of buyer to target. Pass an empty array to include all buyer types.Accepted values:
"strategic", "financial"{
"topic": "Civil Engineering Infrastructure Services",
"workflow": "buyer_analysis",
"workbook_name": "Ulteig Buyers",
"advanced_settings": {
"target": "ulteig",
"detailed_query": "Civil Engineering Infrastructure Services",
"companies": [],
"buyer_type": [],
"company_type": "all",
"geography": ["Worldwide"]
}
}
{
"topic": "Civil Engineering Infrastructure Services",
"workflow": "buyer_analysis",
"workbook_name": "Ulteig Buyers",
"advanced_settings": {
"target": "ulteig",
"detailed_query": "Engineering and consulting firms seeking to expand infrastructure services",
"companies": [],
"buyer_type": ["strategic"],
"company_type": "public",
"geography": ["USA", "CAN"]
}
}
Response
A successful response returns areport_id that identifies the buyer screening report.
Successful Response Fields
Unique identifier for the report created by this request. Use it to track completion and to download the results (see below).
{
"report_id": 117253
}
Tracking Completion and Exporting Results
Buyer Screening generation is asynchronous. After you receive areport_id:
- Use
/api/assets/get_notebook_status/to track completion of the report. - Once the report is complete, use
/api/assets/download_report/to export the results.