> ## 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.
# Enrich Contacts
> Enrich contacts from search results. This is step 3 of the prospecting process.
*Endpoint*: **(POST) https://api.lusha.com/prospecting/contact/enrich**
---
⚠️ **Important Notice - Unified Credits Plan Required**
| Parameter | Requirement |
|-----------|-------------|
| `revealEmails` and `revealPhones` | Only available to customers on the **Unified Credits** pricing plan |
| Plan Restriction | Attempting to use these parameters on other plans will result in a **403 Unauthorized** error |
| Default Behavior | When neither parameter is used, the API returns **both email addresses and phone numbers**, if available |
---
## OpenAPI
````yaml /v2/openapi.json post /prospecting/contact/enrich
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/contact/enrich:
post:
tags:
- Prospecting - Search & Enrich
summary: Enrich Contacts
description: >
Enrich contacts from search results. This is step 3 of the prospecting
process.
*Endpoint*: **(POST) https://api.lusha.com/prospecting/contact/enrich**
---
⚠️ **Important Notice - Unified Credits Plan Required**
| Parameter | Requirement |
|-----------|-------------|
| `revealEmails` and `revealPhones` | Only available to customers on the
**Unified Credits** pricing plan |
| Plan Restriction | Attempting to use these parameters on other plans
will result in a **403 Unauthorized** error |
| Default Behavior | When neither parameter is used, the API returns
**both email addresses and phone numbers**, if available |
---
operationId: enrichProspectingContacts
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ContactEnrichRequest'
examples:
basicExample:
summary: Basic enrichment request
value:
requestId: b6effae6-35b8-493d-91aa-7d3b1b7c7dc7
contactIds:
- 37b4c536-eaec-11ef-ad4b-a75f8e9e1484
unifiedCreditsExample:
summary: Unified Credits plan with selective reveal
value:
requestId: b6effae6-35b8-493d-91aa-7d3b1b7c7dc7
contactIds:
- ddfb6966-741f-4fca-a62b-e553d4ac12f8
revealEmails: false
revealPhones: true
responses:
'200':
description: Enriched contact data
content:
application/json:
schema:
$ref: '#/components/schemas/ContactEnrichResponse'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'429':
$ref: '#/components/responses/TooManyRequests'
'500':
$ref: '#/components/responses/InternalServerError'
components:
schemas:
ContactEnrichRequest:
type: object
properties:
requestId:
type: string
description: The requestId generated in the Prospecting Search response (UUID)
example: b6effae6-35b8-493d-91aa-7d3b1b7c7dc7
contactIds:
type: array
description: An array containing the contact IDs for enrichment. Min 1, max 100.
items:
type: string
example:
- 37b4c536-eaec-11ef-ad4b-a75f8e9e1484
revealEmails:
type: boolean
description: >
Set `revealEmails=true` to retrieve only the email address of the
contact.
Only available to customers on the **Unified Credits** pricing plan.
example: false
revealPhones:
type: boolean
description: >
Set `revealPhones=true` to retrieve only the phone number of the
contact.
Only available to customers on the **Unified Credits** pricing plan.
example: true
required:
- requestId
- contactIds
ContactEnrichResponse:
type: object
properties:
requestId:
type: string
description: The requestId that was used in the request
contacts:
type: array
items:
type: object
properties:
id:
type: string
description: The ID of the contact from the enrichment request
isSuccess:
type: boolean
description: Indicates whether the enrichment process was successful
data:
$ref: '#/components/schemas/ContactEnrichData'
ContactEnrichData:
type: object
properties:
firstName:
type: string
example: Carolina
lastName:
type: string
example: Portela
fullName:
type: string
example: Carolina Portela
isShown:
type: boolean
example: false
jobTitle:
type: string
example: Solutions Engineer
location:
type: object
properties:
city:
type: string
example: Boston
state:
type: string
example: Massachusetts
country:
type: string
example: United States
country_iso2:
type: string
example: US
continent:
type: string
example: North America
emailAddresses:
type: array
items:
$ref: '#/components/schemas/EmailAddress'
phoneNumbers:
type: array
items:
$ref: '#/components/schemas/PhoneNumbers'
companyId:
type: number
example: 3553744
companyName:
type: string
example: Lusha
socialLinks:
type: object
properties:
linkedin:
type: string
example: https://www.linkedin.com/in/carolinaportela/
xUrl:
type: string
example: https://twitter.com/carolina
departments:
type: array
items:
type: string
example: Engineering & Technical
seniority:
type: array
items:
type: object
properties:
id:
type: number
example: 4
value:
type: string
example: senior
company:
type: object
properties:
revenueRange:
type: array
items:
type: number
funding:
$ref: '#/components/schemas/CompanyFunding'
intent:
$ref: '#/components/schemas/CompanyIntent'
mainIndustry:
type: string
subIndustry:
type: string
technologies:
type: array
items:
$ref: '#/components/schemas/CompanyTechnology'
linkedinFollowersCount:
type: integer
description: Number of followers on LinkedIn
example: 1250
linkedinConnectionsCount:
type: integer
description: Number of LinkedIn connections
example: 500
linkedinCertifications:
description: Professional certifications listed on LinkedIn
type: array
items:
$ref: '#/components/schemas/LinkedinCertification'
linkedinCourses:
description: Courses listed on LinkedIn profile
type: array
items:
$ref: '#/components/schemas/LinkedinCourse'
linkedinAwards:
description: Honors and awards listed on LinkedIn profile
type: array
items:
$ref: '#/components/schemas/LinkedinAward'
linkedinSkills:
description: Skills listed on LinkedIn profile
type: array
items:
type: string
example:
- Microsoft Office
- Project Management
- Strategic Planning
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'
EmailAddress:
type: object
properties:
email:
type: string
description: The email address (alternative to 'address')
example: dustin@lusha.com
address:
type: string
description: The email address (alternative to 'email')
example: dustin@lusha.com
emailType:
type: string
description: The type of email address (alternative to 'type')
example: work
enum:
- work
- private
emailConfidence:
type: string
description: The confidence level of the email address
example: A+
updateDate:
type: string
description: The update date of the email address
example: '2020-01-01'
PhoneNumbers:
type: object
properties:
number:
type: string
description: The phone number
example: '+1234567890'
phoneType:
type: string
description: The type of phone number
example: Mobile
enum:
- Mobile
- Direct
- Phone
doNotCall:
type: boolean
description: Indicates whether the phone number is listed as "Do Not Call" (DNC).
example: false
updateDate:
type: string
description: The update date of the phone number
example: '2020-01-01'
required:
- phoneType
- doNotCall
- updateDate
CompanyFunding:
type: object
properties:
rounds:
description: List of funding rounds
type: array
items:
$ref: '#/components/schemas/CompanyFundingRound'
totalRounds:
type: number
example: 2
description: Total number of rounds
totalRoundsAmount:
type: number
example: 245000000
description: Total amount raised across all rounds
currency:
type: string
example: USD
description: Currency used
isIpo:
type: boolean
example: false
description: Whether the company has gone public
lastRoundType:
type: string
example: Private Equity Round
description: Type of the last funding round
lastRoundAmount:
type: number
example: 205000000
description: Amount of the last funding round
lastRoundDate:
type: string
example: Nov 10, 2021
description: Date of the last funding round
required:
- totalRounds
- currency
- isIpo
CompanyIntent:
type: object
properties:
detectedTopics:
description: Detected intent topics
type: array
items:
$ref: '#/components/schemas/CompanyIntentTopic'
topicCount:
type: number
example: 6
description: Number of topics detected
required:
- detectedTopics
- topicCount
CompanyTechnology:
type: object
properties:
name:
type: string
example: salesforce
description: Technology name used by the company
required:
- name
LinkedinCertification:
type: object
properties:
companyId:
type: integer
description: Company ID that issued the certification
example: 1035
companyName:
type: string
description: Name of the company/organization that issued the certification
example: Microsoft
credentialId:
type: string
description: Credential ID for verification
example: abc123
dateMonth:
description: Month the certification was obtained
example: 6
anyOf:
- type: integer
- type: string
dateYear:
description: Year the certification was obtained
example: 2020
anyOf:
- type: integer
- type: string
expireDateMonth:
description: Month the certification expires
example: 6
anyOf:
- type: integer
- type: string
expireDateYear:
description: Year the certification expires
example: 2025
anyOf:
- type: integer
- type: string
linkedinCompanyId:
type: integer
nullable: true
description: LinkedIn company ID
example: 1441
summary:
type: string
nullable: true
description: Description of the certification
example: Azure fundamentals certification covering cloud concepts
title:
type: string
description: Title/name of the certification
example: 'Microsoft Certified: Azure Fundamentals'
verifyUrl:
type: string
nullable: true
description: URL to verify the certification
example: >-
https://www.youracclaim.com/badges/5ccf865c-dd6e-4dcc-9184-c8999d31f83d
LinkedinCourse:
type: object
properties:
activities:
type: string
nullable: true
description: Activities
degree:
type: string
nullable: true
description: Degree
endDate:
type: string
nullable: true
description: End date
endDateMonth:
description: End month
oneOf:
- type: integer
nullable: true
- type: string
nullable: true
endDateYear:
description: End year
oneOf:
- type: integer
nullable: true
- type: string
nullable: true
fieldOfStudy:
type: object
nullable: true
description: Field of study object
properties:
id:
type: string
nullable: true
name:
type: string
nullable: true
grade:
type: string
nullable: true
description: Grade
incompleteEducation:
type: boolean
nullable: true
description: Incomplete education flag
notes:
type: string
nullable: true
description: Notes
school:
type: object
nullable: true
description: School information
properties:
createdAt:
type: string
nullable: true
id:
type: string
nullable: true
logoUrl:
type: string
nullable: true
name:
type: string
nullable: true
updatedAt:
type: string
nullable: true
startDate:
type: string
nullable: true
description: Start date
startDateMonth:
description: Start month
oneOf:
- type: number
nullable: true
- type: string
nullable: true
startDateYear:
description: Start year
oneOf:
- type: number
nullable: true
- type: string
nullable: true
linkedinSchoolId:
type: number
nullable: true
description: LinkedIn school ID
LinkedinAward:
type: object
properties:
companyName:
type: string
nullable: true
description: Name of the organization that gave the award
example: Columbia Southern University
dateDay:
oneOf:
- type: number
- type: string
description: Day the award was received
example: 15
dateMonth:
oneOf:
- type: number
- type: string
description: Month the award was received
example: 7
dateYear:
oneOf:
- type: number
- type: string
description: Year the award was received
example: 2023
linkedinCompanyId:
type: string
nullable: true
description: LinkedIn company ID
summary:
type: string
nullable: true
description: Description of the award
example: Certificate of Recognition for Exceptional Teaching
title:
type: string
description: Title/name of the award
example: Raising the Bar Award
CompanyFundingRound:
type: object
properties:
currency:
type: string
example: USD
description: Currency of the funding round
roundAmount:
type: number
example: 205000000
description: Amount raised in the round
roundType:
type: string
example: Private Equity Round
description: Type of funding round
roundDate:
type: string
example: Nov 10, 2021
description: Date of the funding round
required:
- currency
- roundAmount
- roundType
- roundDate
CompanyIntentTopic:
type: object
properties:
topicName:
type: string
example: Remote Sales
description: Name of the intent topic
metadata:
$ref: '#/components/schemas/CompanyIntentTopicMetadata'
required:
- topicName
- metadata
CompanyIntentTopicMetadata:
type: object
properties:
topicScore:
type: number
example: 83
description: Relevance score for the intent topic
topicTrend:
type: string
example: '-5'
description: Trend of the topic (e.g., +1, -5, New)
required:
- topicScore
- topicTrend
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
Forbidden:
description: Forbidden - account inactive or feature not available
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
accountInactive:
summary: Account inactive
value:
statusCode: 403
message: >-
Your account is not active. Please reach out to support at
support@lusha.com
featureNotAvailable:
summary: Feature not available for pricing plan
value:
statusCode: 403
message: >-
Your pricing version does not support requesting individual
datapoints [revealEmails, revealPhones]
subscriptionLimitReached:
summary: Subscription limit reached
value:
statusCode: 403
message: Maximum subscriptions limit reached for your account
dncNotSupported:
summary: DNC filter not supported on current plan
value:
statusCode: 403
message: >-
Exclude DNC is not supported on your current plan. Please
contact support or your account manager for assistance.
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.
````