Create customer pull lead

POST/workspaces/{organizationId}/customers/pull-leads

Authorization

AuthorizationBearer token · headerrequired

Workspace API key (Authorization: Bearer <key>). Issue keys under Settings → Developer or POST /workspaces/{organizationId}/tokens.

Path parameters

organizationIdstringrequired

Request body

application/json

presetstring

default: "nyc_dob_contractors_and_trades"

Allowed:nyc_dob_contractors_and_tradesnyc_bic_commercial_haulersnyc_dob_permit_issuancesnyc_home_improvement_contractorsnyc_auto_and_garagesnyc_b2b_and_specialty_dealersnyc_bookkeepers_and_cpasnyc_vc_and_acceleratorsnyc_tech_and_software_startupsus_nppes_medical_and_dentalus_sec_form_d_tech_startupsnyc_dob_permit_job_valuenys_tax_warrantsnys_ucc_filingsirs_990_nonprofitsnyc_checkbook

boroughstring

limitinteger

min 1 · max 100 · default: 15

offsetinteger

min 0

ownerIdstring

enrichWebsitesboolean

default: true

dispatchDetectiveBatchboolean

default: false

Responses

200

Pulled non-POS SMB leads from public registries, deduplicated via SMB match key, created owner contacts, recorded signals, and executed lead play

sourceNamestringrequired

pulledCountnumberrequired

createdCountnumberrequired

updatedCountnumberrequired

nextOffsetnumberrequired

detectiveBatchIssueIdstring | null

leadsobject[]required

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer tokenRemember on this deviceInclude my values in samples

Parameters

organizationIdpath*

Bodyapplication/json

presetstringboroughstringlimitintegeroffsetintegerownerIdstringenrichWebsitesbooleandispatchDetectiveBatchboolean

Request

curl -X POST 'https://pile.nyc/workspaces/string/customers/pull-leads' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "preset": "nyc_dob_contractors_and_trades",
  "borough": "string",
  "limit": 15,
  "offset": 0,
  "ownerId": "string",
  "enrichWebsites": true,
  "dispatchDetectiveBatch": false
}'

const response = await fetch("https://pile.nyc/workspaces/string/customers/pull-leads", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json",
    "Content-Type": "application/json"
  },
  body: "{\n  \"preset\": \"nyc_dob_contractors_and_trades\",\n  \"borough\": \"string\",\n  \"limit\": 15,\n  \"offset\": 0,\n  \"ownerId\": \"string\",\n  \"enrichWebsites\": true,\n  \"dispatchDetectiveBatch\": false\n}"
});

import requests

response = requests.post(
    "https://pile.nyc/workspaces/string/customers/pull-leads",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json",
        "Content-Type": "application/json"
    },
    data="{\n  \"preset\": \"nyc_dob_contractors_and_trades\",\n  \"borough\": \"string\",\n  \"limit\": 15,\n  \"offset\": 0,\n  \"ownerId\": \"string\",\n  \"enrichWebsites\": true,\n  \"dispatchDetectiveBatch\": false\n}",
)

Response

{
  "sourceName": "string",
  "pulledCount": 0,
  "createdCount": 0,
  "updatedCount": 0,
  "nextOffset": 0,
  "detectiveBatchIssueId": "string",
  "leads": [
    {
      "property1": null,
      "property2": null
    }
  ]
}