count_companies | Count the companies of the Icypeas lead database that match a filter (a read, free; max 10 calls per second). Argument: query (object, REQUIRED, at least one filter). Filters (each a key of query): text filters { include?: string[], exclude?: string[] } (max 200 values each): name, lid (LinkedIn public id), urn, companyId, type, industry, location, keyword, domain; range filters { ”>”?: number, ”<”?: number, ”>=”?: number, ”<=”?: number }: headcount, revenue; growth filter { timespan: “6months” | “12months” | “24months”, min?: number, max?: number }: headcountGrowth. Prefer alpha-2 country codes for locations (“FR”, “US”); a comma narrows a location (“Paris, France”). Example: { “industry”: { “include”: [“Real Estate”] }, “headcount”: { ”>”: 10 } }. Extracting the companies themselves is not offered (billed per result). |
count_people | Count the people of the Icypeas lead database that match a filter (a read, free; max 10 calls per second). Argument: query (object, REQUIRED, at least one filter). Filters (each a key of query): text filters { include?: string[], exclude?: string[] } (max 200 values each): firstname, lastname, currentJobTitle, pastJobTitle, school, languages, skills, location, profileLocation, workLocation, keyword, currentCompanyName, pastCompanyName, currentCompanyId, pastCompanyId, currentCompanyWebsite, pastCompanyWebsite, currentCompanyUrn, pastCompanyUrn, currentCompany.type, pastCompany.type, currentCompany.industry, pastCompany.industry, currentCompany.location, pastCompany.location, currentCompany.keyword, pastCompany.keyword; range filters { ”>”?: number, ”<”?: number, ”>=”?: number, ”<=”?: number }: totalYearsOfExperience, timeInCurrentCompany, currentCompany.headcount, pastCompany.headcount, currentCompany.revenue, pastCompany.revenue; growth filters { timespan: “6months” | “12months” | “24months”, min?: number, max?: number } (percentages, -100 to 10000): currentCompany.headcountGrowth, pastCompany.headcountGrowth. Prefer alpha-2 country codes for locations (“FR”, “US”); a comma narrows a location (“Paris, France”). Example: { “currentJobTitle”: { “include”: [“CTO”] }, “location”: { “include”: [“FR”] } }. Extracting the people themselves is not offered (billed per result). |
get_search_result | Read the results of single searches (a read, free; max 30 calls per minute). Either id (string, the _id returned by find_email, verify_email or scan_domain) for one result with its status (NONE, SCHEDULED, IN_PROGRESS, FOUND / DEBITED, NOT_FOUND / DEBITED_NOT_FOUND, BAD_INPUT, INSUFFICIENT_FUNDS, ABORTED) and the e-mails found, or no id to list your latest single searches, most recent first: optional type (string, one of email-search, email-verification, domain-scan), limit (integer 1 to 100, default 10), then for the next or previous page pass next (boolean, true = next page) and sorts (the sorts array returned by the previous answer, passed back unchanged). If the status is still NONE, SCHEDULED or IN_PROGRESS, call again in a few seconds. |
get_subscription | Get a subscription and credit information (user id, plan, status, credits, quotas) — a read, free. Argument: email (string, REQUIRED, the e-mail address of the Icypeas account whose subscription to read). |