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.
GET
https://app.softsolz.uk/api/v1/services/my-leads/settingsRecent Requests
Kept only in this browserTimeStatusTook
Send a request with Try it to see it here.
Headers
AuthorizationstringrequiredBearer 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
curl --request GET \ --url https://app.softsolz.uk/api/v1/services/my-leads/settings \ --header 'Authorization: Bearer sk_live_your_key'Credentials
Sent as a Bearer token and used in the samples above and in Try it. Kept only in this browser tab until you close it. Use an sk_test_ key to stay in your sandbox.
Response · 200
{ "data": { "settings": { "company_name": "SoftSolz", "company_website": "https://softsolz.uk", "offering": "Bookkeeping software", "ideal_customer": "Independent retailers with 5-50 staff", "target_industries": "Retail, Hospitality", "avoid_industries": "Gambling", "switching_targets": "Sage, Excel", "default_countries": "United Kingdom", "default_count": 10, "default_deep_verify": false, "kb_sections": [ "overview", "contact" ] }, "icp": { "company_name": "SoftSolz", "target_industries": [ "Retail" ] }, "brief": "We are SoftSolz and we offer bookkeeping software. Prefer these industries: Retail.", "output_schema_hint": { "name": "Company name.", "sections": { "contact": "contact_email, phone." } }, "kb_sections": [ "overview", "contact" ], "lead_statuses": [ "new", "called", "won" ], "section_keys": [ "contact", "social", "sources" ] }}