Read the research brief and the lead schema.

Start here before researching. Returns the workspace settings together with the ideal-customer profile, a prose brief telling you who to find and what to avoid, a hint for every lead field and section, the valid statuses and the section keys. Research with your own model, then save what you found with POST /leads/bulk.

GEThttps://app.softsolz.uk/api/v1/services/my-leads/settings

Recent Requests

TimeStatusUser Agent

Make a request to see history.

Headers

Authorizationstringrequired

Bearer token: `Bearer sk_live_...` (or `sk_test_...` for sandbox). A login token will not work here.

Response

Response Body

settingsobjectThe stored workspace settings.

icpobjectThe ideal-customer profile as structured data: company_name, offering, ideal_customer, target_industries[], avoid_industries[], switching_targets[], default_countries[], default_count.

briefstringThe research brief in prose. Read it before researching; it tells you who to look for, what to avoid and how to save results.

output_schema_hintobjectField-by-field guidance on what to put in each lead property and section.

kb_sectionsarray of stringsSection keys the Knowledge Hub export understands.

lead_statusesarray of stringsValid lead_status values in order.

section_keysarray of stringsEvery key accepted inside sections.

Request

import { SoftSolz } from '@softsolz/sdk';

const client = new SoftSolz({ apiKey: process.env.SOFTSOLZ_API_KEY });

const result = await client.myLeads.getSettings();
console.log(result);

Credentials

Authorization

Sent as a Bearer token. Stored only in your browser.

Response · 200

{
  "data": {
    "settings": {},
    "icp": {},
    "brief": "string",
    "output_schema_hint": {},
    "kb_sections": [],
    "lead_statuses": [],
    "section_keys": []
  }
}