> ## Documentation Index
> Fetch the complete documentation index at: https://docs.lusha.com/llms.txt
> Use this file to discover all available pages before exploring further.
# POST /prospecting/company/search - Search companies
> Search Lusha's B2B company database using firmographic filters: industry, size, revenue, location, technologies, intent topics, and buying signals.
Use this endpoint to find companies in Lusha's database that match your target account criteria. Supply firmographic filters such as industry, employee size, revenue range, technologies in use, and more to build a focused account list. The response includes company IDs you then pass to the [Enrich Companies](/v2/api-reference/prospecting/enrich-companies) endpoint to retrieve full firmographic profiles. This is **step 2** of the three-step prospecting flow.
**Prospecting flow**
| Step | Endpoint | Purpose |
| ---- | ------------------------------------ | -------------------------------------------- |
| 1 | Filters API | Discover valid filter values for your search |
| 2 | **POST /prospecting/company/search** | Query companies using your filters |
| 3 | POST /prospecting/company/enrich | Retrieve full company profiles by ID |
## Endpoint
```
POST https://api.lusha.com/prospecting/company/search
```
**Authentication:** API key (`ApiKeyAuth`)
***
## Request body
The top-level filter container.
Criteria that matching companies must satisfy. The same fields are available under `filters.companies.exclude` to remove companies from results.
Company names to include. Example: `["Apple", "Google"]`
Company domains to include. Example: `["lusha.com"]`
Main industry IDs. Example: `[4, 5]`
Sub-industry IDs. Example: `[101]`
Employee count ranges. Each object has `min` and `max` number fields. Example: `[{ "min": 1, "max": 10 }]`
Revenue ranges. Each object has `min` and `max` values.
HQ location filters. Each object may include `country` and other geographic fields. Example: `[{ "country": "United States" }]`
This filter matches against HQ location only. To find companies with offices in a specific region regardless of HQ, use `companyLocations` instead.
Office location filters based on all known company locations (not just HQ), as reported by LinkedIn.
Each object may include:
* `country` (string) - required
* `state` (string) - optional
Example: `[{ "country": "United States", "state": "California" }, { "country": "Germany" }]`
Filter by LinkedIn-reported employee count. Both `min` and `max` are optional.
Minimum employee count (inclusive). Example: `100`
Maximum employee count (inclusive). Example: `5000`
Filter by technologies the company uses. Each object requires a `name` field. Example: `[{ "name": "Salesforce" }]`
Filter by buyer intent topics. Example: `["Digital Sales"]`
SIC industry codes. Example: `["1011", "1021"]`
NAICS industry codes. Example: `["11", "21"]`
Free-text search across company fields. Example: `"Finance Marketing in Germany"`
**Premium feature.** Filter companies that have signals of the specified types. Credits are charged for each signal type that returns results.
See [GET /api/signals/filters/company](/v2/api-reference/signals/get-signal-options) for available signal type values.
Signal types to match. Allowed values include: `"allSignals"`, `"surgeInHiring"`, `"headcountIncrease6m"`, `"websiteTrafficIncrease"`, `"financialEventsNews"`, and all other company signal types.
Earliest signal date in `YYYY-MM-DD` format. Example: `"2025-01-01"`
When `true`, excludes companies with incomplete data from results.
Same structure as `include`. Companies matching these criteria are removed from results.
Pagination controls.
Page number. Range: `0–1000`.
Results per page. Range: `10–50`.
***
## Example request
```bash cURL theme={null}
curl --request POST \
--url https://api.lusha.com/prospecting/company/search \
--header 'api_key: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"filters": {
"companies": {
"include": {
"mainIndustriesIds": [4, 5],
"sizes": [{ "min": 100, "max": 5000 }],
"locations": [{ "country": "United States" }],
"technologies": [{ "name": "Salesforce" }],
"intentTopics": ["Digital Sales"]
}
}
},
"pages": { "page": 0, "size": 25 }
}'
```
```json Request body theme={null}
{
"filters": {
"companies": {
"include": {
"mainIndustriesIds": [4, 5],
"sizes": [{ "min": 100, "max": 5000 }],
"locations": [{ "country": "United States" }],
"technologies": [{ "name": "Salesforce" }],
"intentTopics": ["Digital Sales"],
"signal": {
"names": ["surgeInHiring", "financialEventsNews"],
"startDate": "2025-01-01"
}
}
}
},
"pages": { "page": 0, "size": 25 }
}
```
***
## Response
### 200 - Success
Unique ID for this search. Pass this to the Enrich Companies endpoint as `requestId`.
The page number returned.
Number of results on this page.
Total number of companies matching your filters across all pages.
Array of matching companies.
Lusha company identifier. Use this in the Enrich Companies request.
Company name.
Company domain. Example: `"lusha.com"`
Company description.
URL to the company logo image.
Signal types detected for this company. Only present when signal filtering was requested.
Whether headcount data is available.
Whether revenue data is available.
Whether main industry classification is available.
Whether sub-industry classification is available.
Whether funding data is available.
Whether buyer intent data is available.
Whether technology stack data is available.
Whether the company's city is available.
Whether the company's country is available.
***
## Error codes
| Status | Meaning |
| ------ | -------------------------------------------------------------------------- |
| `400` | Validation failed - check your request body for missing or invalid fields. |
| `401` | Unauthorized - your API key is missing or invalid. |
| `429` | Too many requests - you have exceeded the rate limit. |
| `500` | Internal server error - retry with exponential backoff. |
```json 200 theme={null}
{
"requestId": "5ad275c8-7dd4-462a-bd45-6bc1970da64e",
"currentPage": 0,
"pageLength": 2,
"totalResults": 874,
"companies": [
{
"id": "33222678",
"name": "Lusha",
"fqdn": "lusha.com",
"description": "Lusha is the sales intelligence platform designed to help businesses get their next customers.",
"logoUrl": "https://logo.lusha.co/logo.jpg",
"hasCompanyEmployeesCount": true,
"hasCompanyRevenue": true,
"hasCompanyMainIndustry": true,
"hasCompanyFunding": true,
"hasCompanyTechnologies": true,
"signalTypes": ["surgeInHiring"]
}
]
}
```
```json 400 theme={null}
{
"statusCode": 400,
"message": "Validation failed",
"errors": ["filters is required"]
}
```
## OpenAPI
````yaml post /prospecting/company/search
openapi: 3.0.3
info:
title: Lusha API Documentation
version: 0.0.1
x-logo:
url: https://www.lusha.com/logo.png
license:
name: Proprietary
url: https://lusha.com/legal/terms
description: >
Lusha provides a RESTful API that allows you to query a comprehensive
dataset of business profiles and company information.
It is designed for teams building prospecting, enrichment, automation, and
analytics workflows that require accurate, continuously updated business
data. The API supports both real-time and bulk use cases and is suitable for
production environments.
Use the Lusha API to search for new prospects, enrich existing records,
react to real-world changes, and expand coverage using lookalike
recommendations.
*All API requests should be made over HTTPS (SSL), and the response bodies
are delivered in JSON format.*
---
---
**Data Source and Privacy**
Please note that **Lusha is a search platform**, meaning the data provided
is not created or directly managed by us. Instead, it is retrieved from
publicly available sources and through contributions from trusted business
partners.
For more information on how we collect, use, and handle business profiles,
please refer to our [Privacy
Policy](https://lusha.com/legal/privacy-notice/).
----
## Authentication
API keys are required for all API and MCP requests and are tied to your
Lusha account and plan. To access the Lusha API, you must authenticate your
requests using your API key. This key is unique to your account and is used
to identify your usage of the API.
How
to Authenticate:
When making an API call, include your API key in the `api_key` header of the
request.
> You can generate and retrieve your API key
[here](https://dashboard.lusha.com/api/manage-api-keys).
API keys should be stored securely and used only in server-side
environments.
---
### Rate Limiting
Lusha API enforces rate limiting to ensure fair usage and protect against
excessive load.
- **General Rate Limit**: You can make up to 25 requests per second to each
API endpoint
- **Credit Usage API**: Has a specific rate limit of 5 requests per minute
> **Note**: Rate limits may vary based on your account type and subscription
plan.
If you're encountering rate limit issues frequently, please consult with your
account manager or Lusha support team to discuss your specific needs.
**Rate Limit Headers**
To monitor your current rate limit status, check the HTTP response headers
in your API calls:
| Header | Description |
|--------|-------------|
| `x-rate-limit-daily` | The total number of requests allowed per day under
your current plan |
| `x-daily-requests-left` | The number of requests remaining in your daily
quota |
| `x-daily-usage` | The number of requests you have made in the current
daily period |
| `x-rate-limit-hourly` | The total number of requests allowed per hour
under your current plan |
| `x-hourly-requests-left` | The number of requests remaining in your hourly
quota |
| `x-hourly-usage` | The number of requests you have made in the current
hourly period |
| `x-rate-limit-minute` | The total number of requests allowed per minute
under your current plan |
| `x-minute-requests-left` | The number of requests remaining in your
current minute window |
| `x-minute-usage` | The number of requests you have made in the current
minute window |
**Notes on API Rate Limiting**
- If you exceed the rate limit, the API will return a 429 (Too Many
Requests) error.
- To ensure a smooth experience, respect the rate limits defined by your
subscription tier.
- Daily limits vary based on your billing plan — higher tiers have higher
quotas.
- You can programmatically track your usage through these response headers:
- `X-RateLimit-Remaining-Daily`
- `X-RateLimit-Reset-Daily`
- It is strongly recommended to implement logic that:
- Monitors these headers
- Pauses or retries requests accordingly
- Helps avoid hitting the limit and ensures reliable operation
---
## Error Codes
Lusha API uses standard HTTP response codes to indicate the status of your
request. These codes help you understand whether the request was successful
or if there was an issue.
| Status Code | Name | Description |
|-------------|------|-------------|
| **200** | OK | Successful request |
| **400** | Bad Request | Badly formatted request |
| **401** | Unauthorized | The API key is invalid |
| **402** | Payment Required | Your account requires payment |
| **403** | Forbidden | Your account is not active. Please reach out to
support at *support@lusha.com* for assistance |
| **403** | Forbidden | Your pricing version does not support requesting
individual datapoints [revealEmails, revealPhones] |
| **404** | Not Found | The requested endpoint was not found |
| **412** | Precondition Failed | The request failed due to invalid syntax
that was provided. Please make sure to send a full name field that contains
a valid first & last name |
| **429** | Too Many Requests | You've reached your trial limit, please
contact support for upgrade |
| **429** | Too Many Requests | Daily API quota limit exceeded. Limit X
calls per day |
| **429** | Too Many Requests | Hourly API rate limit exceeded. Limit: X
calls per hour. Reset in X seconds |
| **451** | Unavailable For Legal Reasons | We are unable to process this
contact request due to our GDPR regulations |
| **499** | Client Closed Request | Request failed due to request timeout |
| **5XX** | Server Error | There's a problem on Lusha's end |
**Error Response Format**
In case of an error, the response body will contain details about the error:
```json
{
"error": {
"code": 400,
"message": "Invalid request parameters"
}
}
```
Handling errors
- Always ensure your API key is correct and valid
- Pay attention to the specific error message and code to troubleshoot
issues efficiently
- Implement proper error handling and retry logic in your application
- For 5XX errors, implement exponential backoff before retrying
---
contact:
name: Lusha Support
url: https://api.lusha.com
email: support@lusha.com
termsOfService: https://lusha.com/legal/terms
x-privacy-policy:
name: Privacy Policy
url: https://lusha.com/legal/privacy-notice/
servers:
- url: https://api.lusha.com
description: Production server
security:
- ApiKeyAuth: []
tags:
- name: Enrichment
description: >-
**What is enrichment?**:
Enrichment is the process of adding missing or updated data to existing
contact or company records.
Use enrichment to:
- Complete CRM records
- Improve outbound accuracy and deliverability
- Keep records current as people and companies change
> Enrichment can be performed in real time or in bulk, depending on the
endpoint and use case.
**Available enrichment APIs**
Person enrichment:
- [**Search single
contact**](/apis/openapi/enrichment/searchsinglecontact) - Enrich one
contact at a time
- [**Search multiple
contacts**](/apis/openapi/enrichment/searchmultiplecontacts) - Bulk enrich
contacts
Company enrichment:
- [**Search a single
company**](/apis/openapi/enrichment/searchsinglecompanyv2) - Enrich one
company at a time
- [**Search multiple
companies**](/apis/openapi/enrichment/searchmultiplecompaniesv2) - Bulk
enrich companies
- name: Prospecting - Search & Enrich
description: >
With Lusha's Prospecting API, you can query Lusha's extensive database
based on specific criteria (such as job title, seniority, location, and
more) to retrieve detailed contact and company information.
The Prospecting API is designed to help you generate new records (contacts
or companies) for your CRM system, using filters that align with your
Ideal Customer Profile (ICP).
This process involves three main steps:
| Step | API | Description |
|------|-----|-------------|
| 1 | **Filters API** | Apply filters to refine your search *(Check
available filters under [Contact](/apis/openapi/contact-filters) and
[Company](/apis/openapi/company-filters) Filters)*|
| 2 | **Search API** | Query
[Contacts](/apis/openapi/prospecting-search-and-enrich/searchprospectingcontacts)
or
[Companies](/apis/openapi/prospecting-search-and-enrich/searchprospectingcompanies)
using the available filters |
| 3 | **Enrich API** | Get full details of
[Contacts](/apis/openapi/prospecting-search-and-enrich/enrichprospectingcontacts)
and
[Companies](/apis/openapi/prospecting-search-and-enrich/enrichprospectingcompanies)
from the search results |
x-tag-expanded: true
- name: Contact Filters
description: Available filters for contact searches
x-parent-tag: Prospecting
- name: Company Filters
description: Available filters for company searches
x-parent-tag: Prospecting
- name: Signals
description: >-
With Lusha’s Signals API, you can enrich your contacts and companies with
timely insights that highlight key account and prospect changes. Signals
help you identify moments of opportunity - from job moves and promotions
to company growth and new initiatives - so you can engage prospects and
customers at exactly the right time. Easily integrate signal data into
enrichment flows, CRM systems, or automation workflows to keep pipelines
and customer records always up to date.
x-tag-expanded: true
- name: Lookalikes
description: >-
Lusha's Lookalikes API helps you discover similar contacts and companies
based on your existing data. Get AI-powered suggestions for new prospects
that match your ideal customer profile.
[**Contact Lookalikes**](/apis/openapi/lookalikes/getcontactlookalikes) -
Find similar contacts based on role, seniority, and industry patterns.
[**Company Lookalikes**](/apis/openapi/lookalikes/getcompanylookalikes)-
Discover companies with similar firmographics and characteristics.
x-tag-expanded: true
- name: Webhooks
description: >
Subscribe to real-time notifications when contacts change jobs or
companies experience key business events.
Webhooks deliver HTTP POST requests to your endpoints when signals occur -
from promotions and job changes to company growth.
> For a full list of available signals, refer to [**Signal
Options**](https://docs.lusha.com/apis/openapi/signals/getsignaloptions).
---
**Key Features:**
- Real-time contact & company signal notifications
- Bulk subscription management (up to 25 items per request)
- Secure delivery with HMAC-SHA256 signatures
- Delivery monitoring with audit logs
**Available Endpoints:**
| Method | Endpoint | Purpose |
|--------|----------|---------|
| POST | `/api/subscriptions` | Create subscriptions (bulk supported) |
| GET | `/api/subscriptions` | List all subscriptions |
| GET | `/api/subscriptions/{id}` | Get subscription by ID |
| PATCH | `/api/subscriptions/{id}` | Update subscription |
| POST | `/api/subscriptions/delete` | Delete subscriptions (bulk
supported) |
| POST | `/api/subscriptions/{id}/test` | Test subscription delivery |
| GET | `/api/audit-logs` | Get webhook delivery logs |
| GET | `/api/audit-logs/stats` | Get delivery statistics |
| GET | `/api/account/secret` | Get account webhook secret |
| POST | `/api/account/secret/regenerate` | Regenerate account secret |
> **Webhook Delivery Acknowledgment:** When receiving webhook deliveries
(POST requests), your endpoint must acknowledge with a specific response
format. See the [Create Subscription](#operation/createSubscription)
endpoint for the required acknowledgment structure.
---
Rate Limits
| Operation | Limit |
|-----------|-------|
| API Requests | 100 requests/minute per account |
| Create Subscriptions | 25 items per request |
| Delete Subscriptions | 25 items per request |
---
Security & Verification
**HTTPS Requirement:**
- Production webhook URLs **must** use HTTPS
- HTTP URLs are not accepted
**Signature Verification:**
All webhook deliveries include an `X-Lusha-Signature` header containing an
HMAC-SHA256 signature. Verify this signature to ensure the request is from
Lusha:
1. Extract the `X-Lusha-Signature` and `X-Lusha-Timestamp` headers
2. Concatenate: `timestamp + "." + JSON.stringify(payload)`
3. Compute HMAC-SHA256 using your webhook secret
4. Compare the computed signature with the received signature
**Example (Node.js):**
```javascript
const crypto = require('crypto');
function verifySignature(payload, signature, timestamp, secret) {
const signedPayload = `${timestamp}.${JSON.stringify(payload)}`;
const expectedSignature = crypto
.createHmac('sha256', secret)
.update(signedPayload)
.digest('hex');
return crypto.timingSafeEqual(
Buffer.from(signature),
Buffer.from(expectedSignature)
);
}
```
> **Security Best Practice:** Always verify webhook signatures to prevent
spoofed requests.
---
Credits & Billing
**Credit Charges:**
- Credits are charged when signals are detected and delivered to your
webhook
- The `creditsCharged` field in the webhook payload indicates how many
credits were used
- Credits are deducted from your account balance per signal type
**No Duplicate Charges:**
- Each signal is delivered once and charged once
- Webhook delivery retries do not incur additional charges
---
Error Response Format
All error responses follow this format:
```json
{
"statusCode": 400,
"message": "Validation failed",
"errors": ["entityType must be one of: contact, company"]
}
```
| Field | Type | Description |
|-------|------|-------------|
| `statusCode` | number | HTTP status code |
| `message` | string | Error message |
| `errors` | string[] | Detailed error messages (optional) |
---
- name: Account Management
description: >
Manage your account and monitor usage.
Use this endpoint to:
- Monitor credit usage
- Understand consumption patterns
- Align API usage with plan limits
- Support governance and production operations
Account-level insights are especially important for teams running Lusha at
scale or across multiple systems.
paths:
/prospecting/company/search:
post:
tags:
- Prospecting - Search & Enrich
summary: Search Companies
description: >
Search for companies using various filters. This is step 2 of the
prospecting process.
*Endpoint*: **(POST) https://api.lusha.com/prospecting/company/search**
---
##### Signal Filtering (Premium Feature)
Filter companies by signal types to identify those with recent business
events and changes.
> **Note:** This is a premium feature. Credits are charged for each signal type that returns results.
operationId: searchProspectingCompanies
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CompanySearchRequest'
examples:
companyLocationsExample:
summary: Filter by site-level office locations (staging only)
value:
pages:
page: 0
size: 20
filters:
companies:
include:
companyLocations:
- country: United States
state: California
- country: Germany
employeesInLinkedInExample:
summary: Filter by LinkedIn employee count range (staging only)
value:
pages:
page: 0
size: 20
filters:
companies:
include:
employeesInLinkedIn:
min: 100
max: 5000
responses:
'200':
description: Search results with company IDs
content:
application/json:
schema:
$ref: '#/components/schemas/CompanySearchResponse'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'429':
$ref: '#/components/responses/TooManyRequests'
'500':
$ref: '#/components/responses/InternalServerError'
components:
schemas:
CompanySearchRequest:
type: object
properties:
pages:
$ref: '#/components/schemas/PaginationParams'
filters:
type: object
properties:
companies:
$ref: '#/components/schemas/CompanyFilters'
required:
- filters
CompanySearchResponse:
type: object
properties:
requestId:
type: string
description: >-
The requestId that should be used in Prospecting Enrich request API
params
currentPage:
type: number
description: Current page of search results
pageLength:
type: number
description: Page length
totalResults:
type: number
description: Total search results
companies:
type: array
items:
$ref: '#/components/schemas/CompanySearchData'
PaginationParams:
type: object
properties:
page:
type: number
description: Page number (0-1000)
minimum: 0
maximum: 1000
default: 0
size:
type: number
description: Page size (10-50)
minimum: 10
maximum: 50
default: 20
CompanyFilters:
type: object
properties:
include:
type: object
properties:
names:
type: array
items:
type: string
example:
- Apple
domains:
type: array
items:
type: string
example: lusha.com
locations:
type: array
items:
type: object
properties:
country:
type: string
example: United States
technologies:
type: array
items:
$ref: '#/components/schemas/CompanyTechnology'
example:
- name: Amazon
intentTopics:
type: array
items:
type: string
example:
- Digital Sales
sizes:
type: array
items:
$ref: '#/components/schemas/CompanySizeRange'
revenues:
type: array
items:
$ref: '#/components/schemas/RevenueRange'
sicCodes:
type: array
items:
type: string
example:
- '1011'
- '1021'
naicsCodes:
type: array
items:
type: string
example:
- '11'
- '21'
mainIndustriesIds:
type: array
items:
type: number
example:
- 4
- 5
subIndustriesIds:
type: array
items:
type: number
example:
- 101
searchText:
type: string
description: Free-text search across company fields
example: Finance Marketing in Germany DE
excludePartialCompanies:
type: boolean
example: false
companyLocations:
type: array
description: >
Filter by company **site-level office locations** as reported by
LinkedIn.
This includes all physical office locations where the company
has a presence.
> **Important:** This is distinct from the `locations` filter,
which matches against
**HQ location only**. Use `companyLocations` when you want to
find companies
with offices in a specific region regardless of where their
headquarters is.
items:
$ref: '#/components/schemas/CompanyLocationFilter2'
example:
- country: United States
state: California
- country: Germany
employeesInLinkedIn:
$ref: '#/components/schemas/EmployeesInLinkedInFilter'
signal:
type: object
description: >
Filter companies by signal types (premium filter - charges apply
per signal type).
For signal filtering. See the [Signal
Options](https://docs.lusha.com/apis/openapi/signals/getsignaloptions)
for available signal types.
properties:
names:
type: array
description: Signal types to filter by
items:
type: string
enum:
- allSignals
- websiteTrafficIncrease
- websiteTrafficDecrease
- itSpendIncrease
- itSpendDecrease
- headcountIncrease1m
- headcountDecrease1m
- headcountIncrease3m
- headcountDecrease3m
- headcountIncrease6m
- headcountDecrease6m
- headcountIncrease12m
- headcountDecrease12m
- surgeInHiring
- surgeInHiringByDepartment
- surgeInHiringByLocation
- riskNews
- commercialActivityNews
- corporateStrategyNews
- financialEventsNews
- peopleNews
- marketIntelligenceNews
- productActivityNews
example:
- commercialActivityNews
- financialEventsNews
startDate:
type: string
format: date
description: Start date for signal detection (YYYY-MM-DD format)
example: '2025-11-01'
exclude:
type: object
description: Same structure as include, for exclusion filters
CompanySearchData:
type: object
properties:
id:
type: string
description: A unique identifier for a Lusha company
name:
type: string
description: The name of the company
fqdn:
type: string
description: The fqdn of the company
description:
type: string
description: A description of the company
logoUrl:
type: string
description: The URL of the company's logo
hasCompanyEmployeesCount:
type: boolean
hasCompanyRevenue:
type: boolean
hasCompanyMainIndustry:
type: boolean
hasCompanySubIndustry:
type: boolean
hasCompanyFunding:
type: boolean
hasCompanyIntent:
type: boolean
hasCompanyTechnologies:
type: boolean
hasCompanyCity:
type: boolean
hasCompanyCountry:
type: boolean
signalTypes:
type: array
description: Types of signals detected for this company
items:
type: string
example: null
ErrorResponse:
type: object
required:
- statusCode
- message
properties:
statusCode:
type: integer
description: HTTP status code
example: 400
message:
type: string
description: Error message
example: Validation failed
errors:
type: array
items:
type: string
description: Detailed error messages (optional, only for validation errors)
example:
- 'entityType must be one of: contact, company'
CompanyTechnology:
type: object
properties:
name:
type: string
example: salesforce
description: Technology name used by the company
required:
- name
CompanySizeRange:
type: object
properties:
min:
type: number
example: 1
max:
type: number
example: 10
RevenueRange:
type: object
properties:
min:
type: number
example: 1
max:
type: number
example: 1000000
CompanyLocationFilter2:
type: object
description: |
Site-level office location filter. At least `country` is required.
`state` without `country` is not supported.
required:
- country
properties:
country:
type: string
example: United States
state:
type: string
example: California
EmployeesInLinkedInFilter:
type: object
description: |
Filter companies by LinkedIn-reported employee count.
Both `min` and `max` are optional — provide either or both.
properties:
min:
type: integer
format: int64
description: Minimum employee count (inclusive)
example: 100
max:
type: integer
format: int64
description: Maximum employee count (inclusive)
example: 5000
responses:
BadRequest:
description: Bad request - invalid input data
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
statusCode: 400
message: Invalid request parameters
Unauthorized:
description: Unauthorized - invalid or missing API key
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
statusCode: 401
message: Invalid API key
TooManyRequests:
description: Too many requests - rate limit exceeded
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
statusCode: 429
message: Too many requests. Please wait before making another request.
headers:
RateLimit-Limit:
description: The total number of allowed requests per second
schema:
type: integer
RateLimit-Remaining:
description: The number of remaining requests in the current window
schema:
type: integer
RateLimit-Reset:
description: The time (in seconds) until the rate limit quota is reset
schema:
type: integer
X-RateLimit-Remaining-Daily:
description: The number of remaining requests for your daily quota
schema:
type: integer
X-RateLimit-Reset-Daily:
description: The time when your daily quota will reset
schema:
type: integer
InternalServerError:
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
statusCode: 500
message: Internal server error. Please try again later.
securitySchemes:
ApiKeyAuth:
type: apiKey
in: header
name: api_key
description: >
Your Lusha API key. You can find this in your Lusha dashboard under API
settings.
Include this key in the `api_key` header for all requests.
````