{ "info": { "_postman_id": "8bd9c1b7-d7f4-4070-b1d8-29730356edf7", "name": "Lead411 V3", "description": "Lead411 V3 REST API \u2014 B2B company and contact data, search, suppression, CRM export, and account utilities.\n\n**Documentation:** [https://api.lead411.com/v3/docs/](https://api.lead411.com/v3/docs/)\n\n**Authentication:** Most endpoints accept `X-API-KEY` or `Authorization: Bearer ` (from Direct Login or OAuth token exchange).\n\n**Rate limits:** Responses may include rate-limit headers; expensive search/export routes share additional limits. See product documentation for defaults and overrides.\n\n**Legacy compatibility:** Some clients expect HTTP 200 with `status: error` for auth failures when legacy mode is enabled on the server.\n", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "variable": [ { "key": "base_url", "value": "https://api.lead411.com/v3", "type": "string" }, { "key": "api_key", "value": "YOUR_API_KEY", "type": "string" }, { "key": "access_token", "value": "YOUR_ACCESS_TOKEN", "type": "string" } ], "item": [ { "name": "Auth", "description": "Login, token refresh, OAuth, session validation, and logout.", "item": [ { "name": "Validate API key or bearer token", "request": { "method": "POST", "header": [ { "key": "X-API-KEY", "value": "{{api_key}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/auth/checkToken", "host": [ "{{base_url}}" ], "path": [ "auth", "checkToken" ] }, "description": "Validate the `X-API-KEY` or Bearer token sent on this request. Empty body is OK.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Authenticate user (email/password)", "request": { "method": "POST", "header": [ { "key": "X-API-KEY", "value": "{{api_key}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/auth/login", "host": [ "{{base_url}}" ], "path": [ "auth", "login" ] }, "description": "Exchange email and password for access and refresh tokens. Use the returned access token as\n`Authorization: Bearer ` on protected routes.\n\nCredentials may be sent as JSON body **or** as query string (PHP v3 parity):\n`POST /auth/login?email=&password=`. JSON body fields win when both are present.", "body": { "mode": "raw", "raw": "{\n \"email\": \"user@example.com\",\n \"password\": \"YOUR_PASSWORD\",\n \"device_name\": \"my-integration\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Refresh access token", "request": { "method": "POST", "header": [ { "key": "X-API-KEY", "value": "{{api_key}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/auth/refresh", "host": [ "{{base_url}}" ], "path": [ "auth", "refresh" ] }, "description": "Refresh an access token using a valid refresh token.", "body": { "mode": "raw", "raw": "{\n \"refresh_token\": \"YOUR_REFRESH_TOKEN\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Logout / invalidate session", "request": { "method": "POST", "header": [ { "key": "X-API-KEY", "value": "{{api_key}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/logout", "host": [ "{{base_url}}" ], "path": [ "logout" ] }, "description": "Log out the current bearer session.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Generate OAuth authorization code", "request": { "method": "POST", "header": [ { "key": "X-API-KEY", "value": "{{api_key}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/oauth/authorize", "host": [ "{{base_url}}" ], "path": [ "oauth", "authorize" ] }, "description": "Start OAuth authorization-code flow and receive a short-lived authorization code.", "body": { "mode": "raw", "raw": "{\n \"client_id\": \"YOUR_CLIENT_ID\",\n \"redirect_uri\": \"https://your-app.example/callback\",\n \"response_type\": \"code\",\n \"state\": \"random-state\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Exchange authorization code or refresh token", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/oauth/token", "host": [ "{{base_url}}" ], "path": [ "oauth", "token" ] }, "description": "Exchange an authorization code or refresh token for access credentials.", "body": { "mode": "raw", "raw": "{\n \"grant_type\": \"authorization_code\",\n \"code\": \"YOUR_AUTH_CODE\",\n \"client_id\": \"YOUR_CLIENT_ID\",\n \"client_secret\": \"YOUR_CLIENT_SECRET\",\n \"redirect_uri\": \"https://your-app.example/callback\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] } ] }, { "name": "Customer", "description": "Account profile, quota, and unlock statistics.", "item": [ { "name": "Get customer details", "request": { "method": "POST", "header": [ { "key": "X-API-KEY", "value": "{{api_key}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/getCustomerDetails", "host": [ "{{base_url}}" ], "path": [ "getCustomerDetails" ] }, "description": "Get account profile details for the authenticated customer. Empty body is OK.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Get customer details (includes customer_id)", "request": { "method": "POST", "header": [ { "key": "X-API-KEY", "value": "{{api_key}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/getCustomerDetailsMore", "host": [ "{{base_url}}" ], "path": [ "getCustomerDetailsMore" ] }, "description": "Same as `getCustomerDetails` plus `customer_id`.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Get customer quota", "request": { "method": "POST", "header": [ { "key": "X-API-KEY", "value": "{{api_key}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/get_customer_quota", "host": [ "{{base_url}}" ], "path": [ "get_customer_quota" ] }, "description": "Current unlock quota balances for the account.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Get customer unlock stats", "request": { "method": "POST", "header": [ { "key": "X-API-KEY", "value": "{{api_key}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/get_customer_unlock_stats_info", "host": [ "{{base_url}}" ], "path": [ "get_customer_unlock_stats_info" ] }, "description": "Quota plus unlock usage statistics.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] } ] }, { "name": "Search", "description": "JSON search, similar companies, employee search helpers, and search export.", "item": [ { "name": "Export search results to file", "request": { "method": "POST", "header": [ { "key": "X-API-KEY", "value": "{{api_key}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/search/exportDownloadFile", "host": [ "{{base_url}}" ], "path": [ "search", "exportDownloadFile" ] }, "description": "Export search results to CSV/XLSX based on the submitted export payload.", "body": { "mode": "raw", "raw": "{\n \"select_action_download\": \"employee\",\n \"employee_id\": \"12345,67890\",\n \"download_all\": \"csv\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Get news category reference data", "request": { "method": "POST", "header": [ { "key": "X-API-KEY", "value": "{{api_key}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/search/getNewsCategoryData", "host": [ "{{base_url}}" ], "path": [ "search", "getNewsCategoryData" ] }, "description": "Return available news category options. Empty body is OK.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Advanced Employee Search", "request": { "method": "POST", "header": [ { "key": "X-API-KEY", "value": "{{api_key}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/search/get_company_employees_data", "host": [ "{{base_url}}" ], "path": [ "search", "get_company_employees_data" ] }, "description": "Advanced employee/company search with legacy PHP-compatible result shape.\nSend a JSON object with any combination of the request body fields below.", "body": { "mode": "raw", "raw": "{\n \"company_ids\": \"1743\",\n \"user_search_string\": \"cisco.com\",\n \"title_keyword\": \"ceo,cfo\",\n \"country_code\": \"US\",\n \"State_array\": \"CA,ON\",\n \"Industry_Codes\": \"48,500\",\n \"industry_linkedin\": \"1430,1247\",\n \"page\": 1,\n \"per_page\": 25\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Get similar companies", "request": { "method": "POST", "header": [ { "key": "X-API-KEY", "value": "{{api_key}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/search/get_similar_companies", "host": [ "{{base_url}}" ], "path": [ "search", "get_similar_companies" ] }, "description": "Provide one of `company_id`, `website`, `domain`, or `url`.", "body": { "mode": "raw", "raw": "{\n \"website\": \"lead411.com\",\n \"limit\": 5\n}", "options": { "raw": { "language": "json" } } } }, "response": [] } ] }, { "name": "Suppression", "description": "Email and company suppression lists.", "item": [ { "name": "Add suppressed company", "request": { "method": "POST", "header": [ { "key": "X-API-KEY", "value": "{{api_key}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/suppression/addSuppCompany", "host": [ "{{base_url}}" ], "path": [ "suppression", "addSuppCompany" ] }, "description": "Add a suppressed company by `company_id` and/or `company_url`.", "body": { "mode": "raw", "raw": "{\n \"company_url\": \"https://www.example.com/\",\n \"company_id\": 0\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Delete suppressed company", "request": { "method": "POST", "header": [ { "key": "X-API-KEY", "value": "{{api_key}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/suppression/deleteAddedSuppCompany", "host": [ "{{base_url}}" ], "path": [ "suppression", "deleteAddedSuppCompany" ] }, "description": "Remove a company suppression.", "body": { "mode": "raw", "raw": "{\n \"company_url\": \"https://www.example.com/\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Delete suppression emails", "request": { "method": "POST", "header": [ { "key": "X-API-KEY", "value": "{{api_key}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/suppression/deleteSuppressionEmail", "host": [ "{{base_url}}" ], "path": [ "suppression", "deleteSuppressionEmail" ] }, "description": "Remove employee suppressions by passing `employee_id_json` as a JSON array string.", "body": { "mode": "raw", "raw": "{\n \"employee_id_json\": \"[12345]\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Get suppression emails", "request": { "method": "POST", "header": [ { "key": "X-API-KEY", "value": "{{api_key}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/suppression/getSuppressionEmails", "host": [ "{{base_url}}" ], "path": [ "suppression", "getSuppressionEmails" ] }, "description": "List suppressed employees and companies for the current account.", "body": { "mode": "raw", "raw": "{\n \"sub_account_email\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Insert suppression emails", "request": { "method": "POST", "header": [ { "key": "X-API-KEY", "value": "{{api_key}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/suppression/insertSuppressionEmail", "host": [ "{{base_url}}" ], "path": [ "suppression", "insertSuppressionEmail" ] }, "description": "Suppress contacts by email and/or employee id. `email_json` and `employee_id_json` are JSON\narray strings, not raw arrays.", "body": { "mode": "raw", "raw": "{\n \"email_json\": \"[\\\"user@example.com\\\"]\",\n \"employee_id_json\": \"\",\n \"sub_account_email\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] } ] }, { "name": "Company", "description": "Company profile, employees, news, jobs, technology, and bulk lookup.", "item": [ { "name": "Get company data bundle", "request": { "method": "POST", "header": [ { "key": "X-API-KEY", "value": "{{api_key}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/company/getCompanyData", "host": [ "{{base_url}}" ], "path": [ "company", "getCompanyData" ] }, "description": "Resolve a list of companies from a `companies` array in the body.", "body": { "mode": "raw", "raw": "{\n \"companies\": [\n {\n \"url\": \"https://www.example.com\",\n \"company_name\": \"Example Inc\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Get company employees", "request": { "method": "POST", "header": [ { "key": "X-API-KEY", "value": "{{api_key}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/company/getCompanyEmployees", "host": [ "{{base_url}}" ], "path": [ "company", "getCompanyEmployees" ] }, "description": "Paginated employee list for a company.", "body": { "mode": "raw", "raw": "{\n \"company_id\": 1743,\n \"page\": 1,\n \"page_size\": 25\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Get company info", "request": { "method": "POST", "header": [ { "key": "X-API-KEY", "value": "{{api_key}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/company/getCompanyInfo", "host": [ "{{base_url}}" ], "path": [ "company", "getCompanyInfo" ] }, "description": "Look up one company by `company_id`, `company_url`, `company_name`, or `linkedin_url`.\nOptional `exclude_data_request` omits named datasets. Allowed values:\n`company_suppression`, `company_outside_tech_data`, `company_inside_tech_data`,\n`indeed_data`, `hiring_zip_code`, `news_data`.", "body": { "mode": "raw", "raw": "{\n \"company_id\": 1743\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Get company jobs", "request": { "method": "POST", "header": [ { "key": "X-API-KEY", "value": "{{api_key}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/company/getCompanyJobs", "host": [ "{{base_url}}" ], "path": [ "company", "getCompanyJobs" ] }, "description": "Returns only `company_id`, `indeed_data`, and `hiring_zip_code`.", "body": { "mode": "raw", "raw": "{\n \"company_id\": 1743\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Get company news", "request": { "method": "POST", "header": [ { "key": "X-API-KEY", "value": "{{api_key}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/company/getCompanyNews", "host": [ "{{base_url}}" ], "path": [ "company", "getCompanyNews" ] }, "description": "Returns only `company_id` and company-specific `news_data`.", "body": { "mode": "raw", "raw": "{\n \"company_id\": 1743\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Get company technology stack", "request": { "method": "POST", "header": [ { "key": "X-API-KEY", "value": "{{api_key}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/company/getCompanyTech", "host": [ "{{base_url}}" ], "path": [ "company", "getCompanyTech" ] }, "description": "Returns `company_id`, company profile `json_meta`, and one page of technologies\nin `company_outside_tech_data`. Pagination applies to this endpoint only\n(`getCompanyInfo` still returns its first 50 technologies and is not paged).\n`page` defaults to 1. `limit` is always 50 per page even if another value is sent.\nResults are ordered by technology id. The response includes `page`, `limit`,\n`total`, and `total_pages`.", "body": { "mode": "raw", "raw": "{\n \"company_id\": 1743,\n \"page\": 1,\n \"limit\": 50\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Bulk company lookup via CSV", "request": { "method": "POST", "header": [ { "key": "X-API-KEY", "value": "{{api_key}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/company/get_company_data_using_csv", "host": [ "{{base_url}}" ], "path": [ "company", "get_company_data_using_csv" ] }, "description": "Bulk company upload via JSON, pipe-separated URLs, or multipart CSV (`company_csv`, `file`,\n`upload_file`, or `csv_file`).", "body": { "mode": "raw", "raw": "{\n \"filename\": \"companies.csv\",\n \"download_all\": \"csv\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Search employees at company", "request": { "method": "POST", "header": [ { "key": "X-API-KEY", "value": "{{api_key}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/company/searchCompanyEmployees", "host": [ "{{base_url}}" ], "path": [ "company", "searchCompanyEmployees" ] }, "description": "Search employees within a company. Identify the company with `company_id` or\n`company_linkedin_url`. `linkedin_url` looks up an employee by their LinkedIn\nprofile (`linkedin.com/in/...`).", "body": { "mode": "raw", "raw": "{\n \"company_linkedin_url\": \"http://www.linkedin.com/company/cisco\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] } ] }, { "name": "Employee", "description": "Employee lookup and unlock.", "item": [ { "name": "Get employee information", "request": { "method": "POST", "header": [ { "key": "X-API-KEY", "value": "{{api_key}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/employee/getEmployeeInformation", "host": [ "{{base_url}}" ], "path": [ "employee", "getEmployeeInformation" ] }, "description": "Find employees by `employee_id`, `email`, `linkedin_url`, or title + company.", "body": { "mode": "raw", "raw": "{\n \"employee_id\": 12345\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Unlock employee record", "request": { "method": "POST", "header": [ { "key": "X-API-KEY", "value": "{{api_key}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/employee/unlock_employee_record", "host": [ "{{base_url}}" ], "path": [ "employee", "unlock_employee_record" ] }, "description": "Unlock one or more employees. `employee_ids_json` must be a JSON array string.", "body": { "mode": "raw", "raw": "{\n \"employee_id\": \"12345\",\n \"employee_ids_json\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] } ] }, { "name": "Options", "description": "Reference data and autocomplete helpers for search filters.", "item": [ { "name": "Legacy alias for `/options/get_search_sortby_options`", "request": { "method": "POST", "header": [ { "key": "X-API-KEY", "value": "{{api_key}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/get_search_sortby_options", "host": [ "{{base_url}}" ], "path": [ "get_search_sortby_options" ] }, "description": "Legacy path alias; same behavior as the canonical `/options/\u2026` route.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Get search sort-by options", "request": { "method": "POST", "header": [ { "key": "X-API-KEY", "value": "{{api_key}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/options/get_search_sortby_options", "host": [ "{{base_url}}" ], "path": [ "options", "get_search_sortby_options" ] }, "description": "Return allowed search sort options. Empty body is OK.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Search area codes", "request": { "method": "POST", "header": [ { "key": "X-API-KEY", "value": "{{api_key}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/options/searchAreaCode", "host": [ "{{base_url}}" ], "path": [ "options", "searchAreaCode" ] }, "description": "Search area codes", "body": { "mode": "raw", "raw": "{\n \"search_string\": \"415\",\n \"limit\": 20\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Search regions", "request": { "method": "POST", "header": [ { "key": "X-API-KEY", "value": "{{api_key}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/options/searchRegion", "host": [ "{{base_url}}" ], "path": [ "options", "searchRegion" ] }, "description": "Search regions", "body": { "mode": "raw", "raw": "{\n \"search_string\": \"California\",\n \"limit\": 20\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Search ZIP/postal codes", "request": { "method": "POST", "header": [ { "key": "X-API-KEY", "value": "{{api_key}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/options/searchZipCode", "host": [ "{{base_url}}" ], "path": [ "options", "searchZipCode" ] }, "description": "Search ZIP/postal codes", "body": { "mode": "raw", "raw": "{\n \"search_string\": \"94105\",\n \"limit\": 20\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Search industry LinkedIn keywords", "request": { "method": "POST", "header": [ { "key": "X-API-KEY", "value": "{{api_key}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/options/search_industry_linkedin_keywords", "host": [ "{{base_url}}" ], "path": [ "options", "search_industry_linkedin_keywords" ] }, "description": "Search LinkedIn industry keywords and return IDs for `industry_linkedin` (also usable as `Industry_Codes` / `industryCode` values over 999). Does not return classic Lead411 industry codes (IDs \u2264 999).", "body": { "mode": "raw", "raw": "{\n \"search_string\": \"technology\",\n \"limit\": 20\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Search job titles", "request": { "method": "POST", "header": [ { "key": "X-API-KEY", "value": "{{api_key}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/options/search_title", "host": [ "{{base_url}}" ], "path": [ "options", "search_title" ] }, "description": "Search job titles", "body": { "mode": "raw", "raw": "{\n \"search_string\": \"ceo\",\n \"limit\": 20\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Search technology names", "request": { "method": "POST", "header": [ { "key": "X-API-KEY", "value": "{{api_key}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/search/search_technology", "host": [ "{{base_url}}" ], "path": [ "search", "search_technology" ] }, "description": "Search technology names used by the options UI.", "body": { "mode": "raw", "raw": "{\n \"search_string\": \"Salesforce\",\n \"limit\": 20\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Legacy alias for `/options/search_title`", "request": { "method": "POST", "header": [ { "key": "X-API-KEY", "value": "{{api_key}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" } ], "url": { "raw": "{{base_url}}/search/search_title", "host": [ "{{base_url}}" ], "path": [ "search", "search_title" ] }, "description": "Legacy path alias; same behavior as the canonical `/options/\u2026` route." }, "response": [] }, { "name": "Legacy alias for `/options/searchAreaCode`", "request": { "method": "POST", "header": [ { "key": "X-API-KEY", "value": "{{api_key}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" } ], "url": { "raw": "{{base_url}}/searchAreaCode", "host": [ "{{base_url}}" ], "path": [ "searchAreaCode" ] }, "description": "Legacy path alias; same behavior as the canonical `/options/\u2026` route." }, "response": [] }, { "name": "Legacy alias for `/options/searchRegion`", "request": { "method": "POST", "header": [ { "key": "X-API-KEY", "value": "{{api_key}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" } ], "url": { "raw": "{{base_url}}/searchRegion", "host": [ "{{base_url}}" ], "path": [ "searchRegion" ] }, "description": "Legacy path alias; same behavior as the canonical `/options/\u2026` route." }, "response": [] }, { "name": "Legacy alias for `/options/searchZipCode`", "request": { "method": "POST", "header": [ { "key": "X-API-KEY", "value": "{{api_key}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" } ], "url": { "raw": "{{base_url}}/searchZipCode", "host": [ "{{base_url}}" ], "path": [ "searchZipCode" ] }, "description": "Legacy path alias; same behavior as the canonical `/options/\u2026` route." }, "response": [] }, { "name": "Legacy alias for `/options/search_industry_linkedin_keywords`", "request": { "method": "POST", "header": [ { "key": "X-API-KEY", "value": "{{api_key}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" } ], "url": { "raw": "{{base_url}}/search_industry_linkedin_keywords", "host": [ "{{base_url}}" ], "path": [ "search_industry_linkedin_keywords" ] }, "description": "Legacy path alias; same behavior as the canonical `/options/\u2026` route." }, "response": [] }, { "name": "Legacy alias for `/options/search_title`", "request": { "method": "POST", "header": [ { "key": "X-API-KEY", "value": "{{api_key}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" } ], "url": { "raw": "{{base_url}}/search_title", "host": [ "{{base_url}}" ], "path": [ "search_title" ] }, "description": "Legacy path alias; same behavior as the canonical `/options/\u2026` route." }, "response": [] } ] }, { "name": "CRM", "description": "CRM configuration, field mapping, and push to default CRM.", "item": [ { "name": "Push employee data to default CRM", "request": { "method": "POST", "header": [ { "key": "X-API-KEY", "value": "{{api_key}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/crm/exportDataToDefaultCRM", "host": [ "{{base_url}}" ], "path": [ "crm", "exportDataToDefaultCRM" ] }, "description": "Push employee and/or company data to the account's default CRM.\nContact path requires `employee_id` or `employee_ids_json`. Company path uses `type` + `company_info`.", "body": { "mode": "raw", "raw": "{\n \"employee_id\": 12345,\n \"action\": \"update\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Get CRM field definitions", "request": { "method": "POST", "header": [ { "key": "X-API-KEY", "value": "{{api_key}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/crm/getCRMFields", "host": [ "{{base_url}}" ], "path": [ "crm", "getCRMFields" ] }, "description": "Get CRM field definitions for mapping.", "body": { "mode": "raw", "raw": "{\n \"crm\": \"salesforce\",\n \"type\": \"contact\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "List supported CRMs", "request": { "method": "POST", "header": [ { "key": "X-API-KEY", "value": "{{api_key}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/crm/get_all_supported_crms", "host": [ "{{base_url}}" ], "path": [ "crm", "get_all_supported_crms" ] }, "description": "List CRM integrations supported for the account/package.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Get configured CRM", "request": { "method": "POST", "header": [ { "key": "X-API-KEY", "value": "{{api_key}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/crm/get_configured_crm", "host": [ "{{base_url}}" ], "path": [ "crm", "get_configured_crm" ] }, "description": "Return the CRM currently configured for the account.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Save CRM field mapping", "request": { "method": "POST", "header": [ { "key": "X-API-KEY", "value": "{{api_key}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/crm/saveCRMMapping", "host": [ "{{base_url}}" ], "path": [ "crm", "saveCRMMapping" ] }, "description": "Save CRM field mappings. `lead_vals` and `crm_vals` are parallel arrays.", "body": { "mode": "raw", "raw": "{\n \"crm\": \"salesforce\",\n \"lead_vals\": [\n \"email\",\n \"first_name\"\n ],\n \"crm_vals\": [\n \"Email\",\n \"FirstName\"\n ],\n \"type\": \"contact\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Get CRM fields (legacy alias)", "request": { "method": "POST", "header": [ { "key": "X-API-KEY", "value": "{{api_key}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" } ], "url": { "raw": "{{base_url}}/getCRMFields", "host": [ "{{base_url}}" ], "path": [ "getCRMFields" ] }, "description": "Get CRM fields (legacy alias)" }, "response": [] }, { "name": "Save CRM mapping (legacy alias)", "request": { "method": "POST", "header": [ { "key": "X-API-KEY", "value": "{{api_key}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" } ], "url": { "raw": "{{base_url}}/saveCRMMapping", "host": [ "{{base_url}}" ], "path": [ "saveCRMMapping" ] }, "description": "Save CRM mapping (legacy alias)" }, "response": [] } ] }, { "name": "Export", "description": "File export and download.", "item": [ { "name": "Create export download", "request": { "method": "POST", "header": [ { "key": "X-API-KEY", "value": "{{api_key}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/export", "host": [ "{{base_url}}" ], "path": [ "export" ] }, "description": "Create a file export. `select_action_download` is required.", "body": { "mode": "raw", "raw": "{\n \"select_action_download\": \"employee\",\n \"employee_id\": \"12345,67890\",\n \"download_all\": \"csv\",\n \"filename\": \"export.csv\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Download export file", "request": { "method": "GET", "header": [ { "key": "X-API-KEY", "value": "{{api_key}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" } ], "url": { "raw": "{{base_url}}/files/{customerID}/{fileName}", "host": [ "{{base_url}}" ], "path": [ "files", "{customerID}", "{fileName}" ] }, "description": "Download a file from a prior export. Returns file bytes (CSV/XLSX/ZIP), not JSON. The path `customerID` must match the authenticated account." }, "response": [] } ] }, { "name": "MCP OAuth", "description": "Claude MCP OAuth discovery and token endpoints (public).", "item": [ { "name": "MCP jwks.json", "request": { "method": "GET", "header": [ { "key": "X-API-KEY", "value": "{{api_key}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" } ], "url": { "raw": "{{base_url}}/claude-mcp/.well-known/jwks.json", "host": [ "{{base_url}}" ], "path": [ "claude-mcp", ".well-known", "jwks.json" ] }, "description": "MCP jwks.json" }, "response": [] }, { "name": "MCP oauth-authorization-server", "request": { "method": "GET", "header": [ { "key": "X-API-KEY", "value": "{{api_key}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" } ], "url": { "raw": "{{base_url}}/claude-mcp/.well-known/oauth-authorization-server", "host": [ "{{base_url}}" ], "path": [ "claude-mcp", ".well-known", "oauth-authorization-server" ] }, "description": "MCP oauth-authorization-server" }, "response": [] }, { "name": "MCP openid-configuration", "request": { "method": "GET", "header": [ { "key": "X-API-KEY", "value": "{{api_key}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" } ], "url": { "raw": "{{base_url}}/claude-mcp/.well-known/openid-configuration", "host": [ "{{base_url}}" ], "path": [ "claude-mcp", ".well-known", "openid-configuration" ] }, "description": "MCP openid-configuration" }, "response": [] }, { "name": "MCP OAuth authorize (browser redirect)", "request": { "method": "GET", "header": [ { "key": "X-API-KEY", "value": "{{api_key}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" } ], "url": { "raw": "{{base_url}}/claude-mcp/oauth/authorize", "host": [ "{{base_url}}" ], "path": [ "claude-mcp", "oauth", "authorize" ] }, "description": "MCP OAuth authorize (browser redirect)" }, "response": [] }, { "name": "MCP browser session login", "request": { "method": "POST", "header": [ { "key": "X-API-KEY", "value": "{{api_key}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" } ], "url": { "raw": "{{base_url}}/claude-mcp/oauth/browser-session-login", "host": [ "{{base_url}}" ], "path": [ "claude-mcp", "oauth", "browser-session-login" ] }, "description": "MCP browser session login" }, "response": [] }, { "name": "MCP OAuth token", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" } ], "url": { "raw": "{{base_url}}/claude-mcp/oauth/token", "host": [ "{{base_url}}" ], "path": [ "claude-mcp", "oauth", "token" ] }, "description": "MCP OAuth token" }, "response": [] } ] } ] }