Lusha API

https://docs.lusha.com/apis/openapi
Admin
Lusha provides a RESTful API that allows you to query a comprehensive dataset of business profiles...
Tokens:45,371
Snippets:444
Trust Score:10
Update:2 months ago
Show doc for...
Tokens:
Raw
### Webhook Implementation Example

Source: https://docs.lusha.com/apis/openapi/webhooks/createsubscription.md

A Node.js implementation example showing signature verification and immediate acknowledgment.

```javascript
app.post('/webhook', async (req, res) => {
    // 1. Verify signature
    if (!verifyWebhookSignature(req)) {
      return res.status(401).json({ error: 'Invalid signature' });
    }
    
    // 2. Queue for async processing
    await queueWebhook(req.body);
    
    // 3. Acknowledge immediately
    res.status(201).json({
      received: true,
      timestamp: new Date().toISOString(),
      webhookId: req.body.id
    });
```

--------------------------------

### Webhook Handling Implementation Example (Node.js)

Source: https://docs.lusha.com/apis/openapi/webhooks

This JavaScript example demonstrates how to handle an incoming webhook in a Node.js application. It includes signature verification, queuing for asynchronous processing, and sending the required acknowledgment response.

```javascript
app.post('/webhook', async (req, res) => {
  // 1. Verify signature
  if (!verifyWebhookSignature(req)) {
    return res.status(401).json({ error: 'Invalid signature' });
  }
  
  // 2. Queue for async processing
  await queueWebhook(req.body);
  
  // 3. Acknowledge immediately
  res.status(201).json({
    received: true,
    timestamp: new Date().toISOString(),
    webhookId: req.body.id
  });
  
}
```

--------------------------------

### Webhook Payload Examples

Source: https://docs.lusha.com/apis/openapi/webhooks/createsubscription.md

Examples of the JSON payload structure received by your webhook URL for different signal types.

```json
{
      "id": "f3b87e05-0402-4f3e-8e26-6a38fd0ad62c",
      "type": "promotion",
      "entityType": "contact",
      "entityId": "4158887495",
      "subscriptionId": "507f1f77bcf86cd799439011",
      "data": {
        "personId": 4158887495,
        "currentCompanyId": 40823133,
        "currentCompanyName": "OMG Hospitality Group LLC",
        "currentDomain": "omghospitalitygroup.com",
        "currentTitle": "Bartender",
        "currentDepartments": [
          { "id": 7, "value": "Other" }
        ],
        "previousCompanyName": "First Watch Restaurants",
        "previousDomain": "firstwatch.com",
        "signalDate": "2025-07-01"
      },
      "timestamp": "2026-01-14T16:16:35.841Z",
      "billing": {
        "creditsCharged": 1
      }
    }
```

```json
{
              "id": "a7c92f14-1234-4b3e-9d22-8b4fe1d0bc45",
              "type": "commercialActivityNews",
              "entityType": "company",
              "entityId": "33222678",
              "subscriptionId": "507f1f77bcf86cd799439011",
              "data": {
                "companyId": "33222678",
                "companyName": "Lusha",
                "domain": "lusha.com",
                "signalId": "1503910",
                "eventType": "partnership",
                "eventSummary": "Lusha announced a strategic partnership with Salesforce.",
                "articlePublishedDate": "2025-06-15",
                "articleTitle": "Lusha Partners with Salesforce",
                "articleHighlight": "The partnership enables Salesforce users to access Lusha data directly within their CRM.",
                "eventEffectiveDate": "2025-06-10",
                "articleUrl": "https://example.com/lusha-salesforce-partnership"
              },
              "timestamp": "2026-01-14T16:16:35.841Z",
              "billing": {
                "creditsCharged": 1
              }
            }
```

--------------------------------

### GET /api/audit-logs/stats

Source: https://docs.lusha.com/apis/openapi

Get delivery statistics for your account.

```APIDOC
## GET /api/audit-logs/stats

### Description
Get delivery statistics for your account.

### Method
GET

### Endpoint
https://api.lusha.com/api/audit-logs/stats
```

--------------------------------

### GET /v3/companies/signals/types

Source: https://docs.lusha.com/apis/openapi/signals/getcompanysignaltypes

Retrieves the full list of supported signal types for companies.

```APIDOC
## GET /v3/companies/signals/types

### Description
Returns the full list of supported signal types for companies.

### Method
GET

### Endpoint
/v3/companies/signals/types

### Response
#### Success Response (200)
- **signalTypes** (array) - List of supported signal types

#### Error Response (401)
- **statusCode** (integer) - HTTP status code
- **message** (string) - Error message
- **errors** (array) - Detailed error messages (optional)
```

--------------------------------

### Get Account Usage

Source: https://docs.lusha.com/apis/openapi/account

Returns a full snapshot of your account status, including credits, rate limits, plan details, and pricing.

```APIDOC
## GET /v3/account/usage

### Description
Returns a full snapshot of your account status: Credits (total, used, and remaining for the current billing cycle), Rate limits (current usage and reset times for daily, hourly, and per-minute windows), Plan (your current plan category and renewal dates), and Pricing (credit cost per action type across all public API endpoints).

### Method
GET

### Endpoint
/v3/account/usage

### Parameters
#### Query Parameters
None

### Response
#### Success Response (200)
- **credits** (object) - Total, used, and remaining credits for the current billing cycle.
- **rate_limits** (object) - Current usage and reset times for daily, hourly, and per-minute windows.
- **plan** (object) - Your current plan category and renewal dates.
- **pricing** (object) - Credit cost per action type across all public API endpoints.
```

--------------------------------

### GET /api/subscriptions

Source: https://docs.lusha.com/apis/openapi/webhooks/listsubscriptions.md

Retrieves a paginated list of all webhook subscriptions for the authenticated account.

```APIDOC
## GET /api/subscriptions

### Description
Returns all webhook subscriptions for your account with pagination support. Results are sorted by createdAt in descending order.

### Method
GET

### Endpoint
https://api.lusha.com/api/subscriptions

### Parameters
#### Query Parameters
- **limit** (integer) - Optional - Maximum number of results (1-100). Default is 10.
- **offset** (integer) - Optional - Number of results to skip.

### Response
#### Success Response (200)
- **data** (array) - List of subscription objects.
- **data.id** (string) - Unique identifier of the subscription.
- **data.entityType** (string) - The type of entity (contact or company).
- **data.entityId** (string) - The ID of the entity.
- **data.signalTypes** (array) - List of signal types.
- **data.url** (string) - The webhook destination URL.
- **data.name** (string) - Name of the subscription.
- **data.isActive** (boolean) - Status of the subscription.
- **data.blockReason** (string) - Reason for disabling, if applicable.
- **data.blockedAt** (string) - Timestamp when disabled, if applicable.
- **data.createdAt** (string) - Creation timestamp.
- **data.updatedAt** (string) - Last update timestamp.
- **pagination** (object) - Pagination metadata.
- **pagination.total** (integer) - Total count of subscriptions.
- **pagination.limit** (integer) - Limit used for the request.
- **pagination.offset** (integer) - Offset used for the request.
- **pagination.hasMore** (boolean) - Indicates if more pages are available.

#### Error Response (400)
- **statusCode** (integer) - HTTP status code.
- **message** (string) - Error description.
- **errors** (array) - Detailed validation errors.
```

--------------------------------

### GET /v3/companies/signals/filters

Source: https://docs.lusha.com/apis/openapi/signals/getcompanysignalfilters

Retrieves all available filter types for company signals and their query requirements.

```APIDOC
## GET /v3/companies/signals/filters

### Description
Returns all available filter types for company signals and whether each requires a search query.

### Method
GET

### Endpoint
/v3/companies/signals/filters

### Response
#### Success Response (200)
- **availableFilters** (array) - List of available filters
- **availableFilters.filterType** (string) - The type of the filter
- **availableFilters.requiresQuery** (boolean) - Indicates if the filter requires a search query

#### Error Response (401)
- **statusCode** (integer) - HTTP status code
- **message** (string) - Error message
- **errors** (array) - Detailed error messages
```

--------------------------------

### Get Company Filter Types

Source: https://docs.lusha.com/apis/openapi/filters

Returns all available filter types for company prospecting and whether each requires a search query.

```APIDOC
## GET /v3/companies/prospecting/filters

### Description
Returns all available filter types for company prospecting and whether each requires a search query.

### Method
GET

### Endpoint
/v3/companies/prospecting/filters

### Parameters
#### Query Parameters
- **searchQuery** (string) - Optional - A search query string to filter filter types. (Required for some filter types like 'names', 'technologies', 'locations')

### Response
#### Success Response (200)
- **filterType** (string) - The name of the filter type.
- **queryRequired** (boolean) - Indicates if a search query is required for this filter type.
```

--------------------------------

### GET /v3/companies/tables/{table_id}/columns

Source: https://docs.lusha.com/apis/openapi/companies-tables/listcompaniestablecolumns

Retrieves the columns for a specified company table, including their configuration and processing status counts.

```APIDOC
## GET /v3/companies/tables/{table_id}/columns

### Description
List the columns on a table, with type and aggregated per-cell status counts.

### Method
GET

### Endpoint
/v3/companies/tables/{table_id}/columns

### Parameters
#### Path Parameters
- **table_id** (string) - Required - The table's ID.

#### Query Parameters
- **email** (string) - Optional - Email of the user making the request. Used to scope ownership/visibility checks.

### Response
#### Success Response (200)
- **data** (array) - List of columns
- **data.columnId** (string) - Column identifier
- **data.name** (string) - Column display name
- **data.type** (string) - Column type (lusha, crm, signal, ai, score)
- **data.key** (string) - Column key
- **data.isDefault** (boolean) - Indicates if the column is a default Lusha column
- **data.addedAt** (string) - Timestamp of creation
- **data.updatedAt** (string) - Timestamp of last update
- **data.rowsNotRun** (integer) - Count of rows not run
- **data.rowsProcessing** (integer) - Count of rows currently processing
- **data.rowsSuccess** (integer) - Count of successful rows
- **data.rowsNoData** (integer) - Count of rows with no data
- **data.rowsFailed** (integer) - Count of failed rows
- **billing** (object) - Credit usage summary
- **billing.creditsCharged** (integer) - Total credits charged
- **billing.resultsReturned** (integer) - Number of successful results returned

#### Error Response (401)
- **statusCode** (integer) - HTTP status code
- **message** (string) - Error message
- **errors** (array) - Detailed error messages
```

--------------------------------

### Get Contact Filter Types

Source: https://docs.lusha.com/apis/openapi/filters

Returns all available filter types for contact prospecting and whether each requires a search query.

```APIDOC
## GET /v3/contacts/prospecting/filters

### Description
Returns all available filter types for contact prospecting and whether each requires a search query.

### Method
GET

### Endpoint
/v3/contacts/prospecting/filters

### Parameters
#### Query Parameters
- **searchQuery** (string) - Optional - A search query string to filter filter types. (Required for some filter types like 'locations')

### Response
#### Success Response (200)
- **filterType** (string) - The name of the filter type.
- **queryRequired** (boolean) - Indicates if a search query is required for this filter type.
```

--------------------------------

### GET /v3/companies/prospecting/filters/{filterType}

Source: https://docs.lusha.com/apis/openapi/filters/getcompanyfiltervalues

Returns valid values for a single company filter type. Some filter types require a query parameter.

```APIDOC
## GET /v3/companies/prospecting/filters/{filterType}

### Description
Returns valid values for a single company filter type.

### Method
GET

### Endpoint
/v3/companies/prospecting/filters/{filterType}

### Parameters
#### Path Parameters
- **filterType** (string) - Required - Enum: "names", "sizes", "revenues", "locations", "sics", "naics", "industriesLabels", "intentTopics", "technologies"

#### Query Parameters
- **query** (string) - Optional - Search query required for specific filter types (names, technologies, locations).

### Response
#### Success Response (200)
- **values** (any) - Filter values (shape depends on filter type)

#### Error Response (400)
- **statusCode** (integer) - HTTP status code
- **message** (string) - Error message
- **errors** (array) - Detailed error messages
```

--------------------------------

### POST /v3/companies/tables

Source: https://docs.lusha.com/apis/openapi/signals/getsignaloptions

Create a new company table.

```APIDOC
## POST /v3/companies/tables

### Description
Creates a new persistent table for company data.

### Method
POST

### Endpoint
/v3/companies/tables
```

--------------------------------

### POST /webhooks/subscriptions

Source: https://docs.lusha.com/apis/openapi/webhooks/createsubscription.md

Creates a batch of webhook subscriptions with optional default settings.

```APIDOC
## POST /webhooks/subscriptions

### Description
Creates a batch of webhook subscriptions. You can define global defaults for the URL, entity type, and signal types, and override them for individual subscriptions.

### Request Body
- **defaults** (object) - Required - Default configuration for subscriptions
  - **url** (string) - Required - Webhook URL (HTTPS required in production)
  - **entityType** (string) - Optional - Default entity type ("contact" or "company")
  - **signalTypes** (array) - Optional - Default signal types
- **name** (string) - Optional - Default subscription name prefix
- **subscriptions** (array) - Required - Array of subscriptions to create (max 25)
  - **entityId** (string) - Required - Entity ID
  - **entityType** (string) - Optional - Overrides default entityType
  - **signalTypes** (array) - Optional - Overrides default signalTypes
  - **name** (string) - Optional - Overrides default name

### Response
#### Success Response (201)
- **total** (integer) - Total number of subscriptions processed
- **successful** (integer) - Number of successful creations
- **failed** (integer) - Number of failed creations
- **results** (array) - List of results

#### Error Response (400)
- **statusCode** (integer) - HTTP status code
- **message** (string) - Error message
- **errors** (array) - Detailed validation error messages
```

--------------------------------

### GET /v3/companies/tables/{table_id}/entities

Source: https://docs.lusha.com/apis/openapi/signals/getsignaloptions

Read rows in a table.

```APIDOC
## GET /v3/companies/tables/{table_id}/entities

### Description
Reads the rows (entities) currently stored in a specific table.

### Method
GET

### Endpoint
/v3/companies/tables/{table_id}/entities
```

--------------------------------

### GET /api/subscriptions

Source: https://docs.lusha.com/apis/openapi

Retrieves a list of all active webhook subscriptions for the account.

```APIDOC
## GET /api/subscriptions

### Description
List all subscriptions.

### Method
GET

### Endpoint
/api/subscriptions
```

--------------------------------

### POST /v3/companies/tables

Source: https://docs.lusha.com/apis/openapi/companies-tables/createcompaniestable

Creates a new, empty companies table, optionally seeded with an initial list of company IDs.

```APIDOC
## POST /v3/companies/tables

### Description
Create a new, empty companies table, optionally seeded with an initial list of company IDs.

### Method
POST

### Endpoint
/v3/companies/tables

### Parameters
#### Request Body
- **name** (string) - Required - The name of the companies table.
- **visibility** (string) - Optional - The visibility of the table (private, shared).
- **owner** (object) - Required - Identifies the user acting on the table.
- **owner.email** (string) - Required - Must resolve to an existing user on the account tied to your API key.
- **ids** (array) - Optional - Initial entity IDs to seed the table with.

### Request Example
{
  "name": "postman-companies",
  "visibility": "private",
  "owner": {
    "email": "user@example.com"
  },
  "ids": ["10042851", "10042852"]
}

### Response
#### Success Response (201)
- **data** (object) - Response payload for the created table.
- **billing** (object) - Credit usage summary for the request.

#### Response Example
{
  "data": {
    "tableId": "482910",
    "name": "VP Sales US Tech Q2",
    "entityType": "companies",
    "visibility": "private",
    "status": "active",
    "owner": {
      "id": 12345,
      "email": "owner@lusha.com",
      "name": "Ada Lovelace"
    },
    "createdBy": {
      "surface": "api",
      "createdByUserId": 12345
    },
    "workspaceUrl": "https://workspace.lusha.com/tables/482910",
    "entityCount": 5,
    "isProcessing": false,
    "columns": []
  },
  "billing": {
    "creditsCharged": 3,
    "resultsReturned": 1
  }
}
```

--------------------------------

### POST /v3/contacts/tables

Source: https://docs.lusha.com/apis/openapi/contacts-tables/createcontactstable

Create a new, empty contacts table, optionally seeded with an initial list of contact IDs.

```APIDOC
## POST /v3/contacts/tables

### Description
Create a new, empty contacts table, optionally seeded with an initial list of contact IDs.

### Method
POST

### Endpoint
/v3/contacts/tables

### Parameters
#### Request Body
- **name** (string) - Required - The name of the table.
- **visibility** (string) - Optional - The visibility of the table (private, shared).
- **owner** (object) - Required - Identifies the user acting on the table.
- **owner.email** (string) - Required - The email of the user on the account.
- **ids** (array) - Optional - Initial entity IDs to seed the table with.

### Request Example
{
  "name": "postman-companies",
  "visibility": "private",
  "owner": {
    "email": "user@example.com"
  },
  "ids": ["10042851", "10042852"]
}

### Response
#### Success Response (201)
- **data** (object) - The created table details.
- **billing** (object) - Credit usage summary.

#### Response Example
{
  "data": {
    "tableId": "482910",
    "name": "VP Sales US Tech Q2",
    "entityType": "contacts",
    "visibility": "private",
    "status": "active",
    "owner": {
      "id": 12345,
      "email": "owner@lusha.com",
      "name": "Ada Lovelace"
    }
  },
  "billing": {
    "creditsCharged": 3,
    "resultsReturned": 1
  }
}
```

--------------------------------

### GET /api/subscriptions/{id}

Source: https://docs.lusha.com/apis/openapi/webhooks

Retrieves details for a specific webhook subscription by its ID.

```APIDOC
## GET /api/subscriptions/{id}

### Description
Retrieves details for a specific webhook subscription by its ID.

### Method
GET

### Endpoint
/api/subscriptions/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the subscription to retrieve.

### Response
#### Success Response (200)
- **id** (string) - The unique identifier for the subscription.
- **signalType** (string) - The type of signal subscribed to.
- **url** (string) - The URL for webhook delivery.
- **createdAt** (string) - The timestamp when the subscription was created.

#### Response Example
{
  "id": "sub_abc123",
  "signalType": "job_change",
  "url": "https://your-webhook-url.com/event",
  "createdAt": "2023-10-27T10:00:00Z"
}

### Error Handling
- **401 Unauthorized**: Returned if the API key is invalid or missing.
- **403 Forbidden**: Returned if the user does not have permission to view the subscription.
- **404 Not Found**: Returned if a subscription with the specified ID does not exist.
```

--------------------------------

### POST /v3/companies/tables/{table_id}/columns/{column_id}/run

Source: https://docs.lusha.com/apis/openapi

Populate or refresh a column's data for some or all rows in the table.

```APIDOC
## POST /v3/companies/tables/{table_id}/columns/{column_id}/run

### Description
Populate or refresh a column's data for some or all rows in the table. This is an asynchronous operation.

### Method
POST

### Endpoint
/v3/companies/tables/{table_id}/columns/{column_id}/run

### Parameters
#### Path Parameters
- **table_id** (string) - Required - The ID of the companies table.
- **column_id** (string) - Required - The ID of the column to run.
```

--------------------------------

### POST /v3/companies/lookalike

Source: https://docs.lusha.com/apis/openapi/lookalikes

Find companies similar to a set of seed companies using AI-powered recommendations.

```APIDOC
## POST /v3/companies/lookalike

### Description
Find companies similar to a set of seed companies using AI-powered recommendations. Provide 5-100 seed companies via domains or LinkedIn URLs.

### Method
POST

### Endpoint
/v3/companies/lookalike

### Parameters
#### Request Body
- **seedCompanies** (array) - Required - 5-100 seed companies (domains or LinkedIn URLs)
- **dedupeSessionId** (string) - Optional - Session ID for pagination without duplicates
- **exclude** (array) - Optional - List of companies to filter out
- **tableId** (string) - Optional - ID of the table to persist matching results
```

--------------------------------

### GET /v3/contacts/signals/types

Source: https://docs.lusha.com/apis/openapi/signals/getcontactsignaltypes

Retrieves the full list of supported signal types for contacts.

```APIDOC
## GET /v3/contacts/signals/types

### Description
Returns the full list of supported signal types for contacts.

### Method
GET

### Endpoint
/v3/contacts/signals/types

### Response
#### Success Response (200)
- **signalTypes** (array) - List of supported signal types.

#### Response Example
{
  "signalTypes": ["allSignals", "promotion", "companyChange"]
}

#### Error Response (401)
- **statusCode** (integer) - HTTP status code
- **message** (string) - Error message
- **errors** (array) - Detailed error messages
```

--------------------------------

### POST /api/subscriptions

Source: https://docs.lusha.com/apis/openapi/webhooks

Creates one or more webhook subscriptions for real-time signal notifications. Supports bulk creation up to 25 subscriptions per request. Webhook deliveries are retried automatically on failures and logged.

```APIDOC
## POST /api/subscriptions

### Description
Creates one or more webhook subscriptions for real-time signal notifications. Supports bulk creation up to 25 subscriptions per request. Webhook deliveries are retried automatically on failures and logged.

### Method
POST

### Endpoint
/api/subscriptions

### Parameters
#### Request Body
- **subscriptions** (array) - Required - An array of subscription objects to create.
  - **signalType** (string) - Required - The type of signal to subscribe to.
  - **contactId** (string) - Optional - The ID of the contact for contact-related signals.
  - **companyId** (string) - Optional - The ID of the company for company-related signals.
  - **url** (string) - Required - The URL to which webhook POST requests will be sent.

### Request Example
{
  "subscriptions": [
    {
      "signalType": "job_change",
      "contactId": "con_123",
      "url": "https://your-webhook-url.com/event"
    },
    {
      "signalType": "company_growth",
      "companyId": "com_456",
      "url": "https://your-webhook-url.com/event"
    }
  ]
}

### Response
#### Success Response (200)
- **subscriptions** (array) - An array of created subscription objects.
  - **id** (string) - The unique identifier for the subscription.
  - **signalType** (string) - The type of signal subscribed to.
  - **url** (string) - The URL for webhook delivery.
  - **createdAt** (string) - The timestamp when the subscription was created.

#### Response Example
{
  "subscriptions": [
    {
      "id": "sub_abc123",
      "signalType": "job_change",
      "url": "https://your-webhook-url.com/event",
      "createdAt": "2023-10-27T10:00:00Z"
    }
  ]
}

### Error Handling
- **400 Bad Request**: Returned if the request body is invalid or missing required fields.
- **401 Unauthorized**: Returned if the API key is invalid or missing.
- **403 Forbidden**: Returned if the user does not have permission to create subscriptions.
- **429 Too Many Requests**: Returned if the rate limit is exceeded.
```

--------------------------------

### GET /v3/companies/prospecting/filters/{filterType}

Source: https://docs.lusha.com/apis/openapi

Returns valid values for a single company filter type.

```APIDOC
## GET /v3/companies/prospecting/filters/{filterType}

### Description
Returns valid values for a single company filter type.

### Method
GET

### Endpoint
/v3/companies/prospecting/filters/{filterType}

### Parameters
#### Path Parameters
- **filterType** (string) - Required - The type of company filter (e.g., sizes, revenues, sics, naics, intentTopics, industriesLabels, names, technologies, locations)
```

--------------------------------

### POST /v3/companies/tables/{table_id}/columns/{column_id}/run

Source: https://docs.lusha.com/apis/openapi/companies-tables/runcompaniestablecolumn

Triggers an asynchronous operation to populate or refresh data for a specific column in a companies table.

```APIDOC
## POST /v3/companies/tables/{table_id}/columns/{column_id}/run

### Description
Populate or refresh a column's data for some or all rows in the table. This is an asynchronous operation.

### Method
POST

### Endpoint
/v3/companies/tables/{table_id}/columns/{column_id}/run

### Parameters
#### Path Parameters
- **table_id** (string) - Required - The table's ID.
- **column_id** (string) - Required - The column's ID.

#### Request Body
- **runScope** (string) - Required - Controls which rows a column operation applies to. Enum: "all", "missing", "specific".
- **entityIds** (array) - Optional - Required when runScope is specific.
- **owner** (object) - Required - Identifies the user acting on the table.
- **owner.email** (string) - Optional - Must resolve to an existing user on the account.

### Request Example
{
  "runScope": "missing",
  "owner": {
    "email": "user@example.com"
  }
}

### Response
#### Success Response (200)
- **data.columnId** (string) - The ID of the column.
- **data.runScope** (string) - The scope used for the operation.
- **data.status** (string) - The current status of the operation (e.g., "processing").
- **billing.creditsCharged** (integer) - Total credits charged.
- **billing.resultsReturned** (integer) - Number of successful results returned.

#### Response Example
{
  "data": {
    "columnId": "c1",
    "runScope": "missing",
    "status": "processing"
  },
  "billing": {
    "creditsCharged": 3,
    "resultsReturned": 1
  }
}
```

--------------------------------

### GET /v3/companies/signals/filters/{filterType}

Source: https://docs.lusha.com/apis/openapi/signals/getsignaloptions

Retrieves details for a specific company signal filter type.

```APIDOC
## GET /v3/companies/signals/filters/{filterType}

### Description
Retrieves details for a specific company signal filter type.

### Method
GET

### Endpoint
/v3/companies/signals/filters/{filterType}

### Parameters
#### Path Parameters
- **filterType** (string) - Required - The type of filter to retrieve.
```

--------------------------------

### GET /api/audit-logs/stats

Source: https://docs.lusha.com/apis/openapi/webhooks/getauditlogstats.md

Retrieves delivery statistics for the account, optionally filtered by subscription ID.

```APIDOC
## GET /api/audit-logs/stats

### Description
Get delivery statistics for your account.

### Method
GET

### Endpoint
https://api.lusha.com/api/audit-logs/stats

### Parameters
#### Query Parameters
- **subscriptionId** (string) - Optional - Filter statistics by subscription ID

### Response
#### Success Response (200)
- **total** (integer) - Total count
- **success** (integer) - Success count
- **failed** (integer) - Failed count
- **successRate** (string) - Success rate percentage

#### Error Response (401)
- **statusCode** (integer) - HTTP status code
- **message** (string) - Error message
- **errors** (array) - Detailed error messages
```

--------------------------------

### Test Subscription

Source: https://docs.lusha.com/apis/openapi/webhooks

Tests a webhook subscription by sending a test signal. Supports three test modes: direct, kafka, and full.

```APIDOC
## Test Subscription

### Description
Tests a webhook subscription by sending a test signal. Supports three test modes: `direct` (quick HTTP check), `kafka` (fanout handler check), and `full` (complete Kafka flow, default). Test deliveries do not consume credits and use mock data.

### Method
POST

### Endpoint
/api/subscriptions/{id}/test

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the subscription to test.

#### Query Parameters
- **mode** (string) - Optional - The test mode. Options: `direct`, `kafka`, `full`. Defaults to `full`.

### Response
#### Success Response (200)
- **message** (string) - Confirmation message indicating the test was initiated.

#### Response Example
```json
{
  "message": "Test signal sent successfully."
}
```
```

--------------------------------

### POST /v3/contacts/tables/{table_id}/columns/{column_id}/run

Source: https://docs.lusha.com/apis/openapi/contacts-tables/runcontactstablecolumn

Populate or refresh a column's data for some or all rows in the table.

```APIDOC
## POST /v3/contacts/tables/{table_id}/columns/{column_id}/run

### Description
Populate or refresh a column's data for some or all rows in the table. This is an asynchronous operation that returns immediately with a status of 'processing'.

### Method
POST

### Endpoint
/v3/contacts/tables/{table_id}/columns/{column_id}/run

### Parameters
#### Path Parameters
- **table_id** (string) - Required - The table's ID.
- **column_id** (string) - Required - The column's ID.

#### Request Body
- **runScope** (string) - Required - Controls which rows a column operation applies to. Enum: "all", "missing", "specific".
- **entityIds** (array) - Optional - Required when runScope is specific.
- **owner** (object) - Required - Identifies the user acting on the table.
- **owner.email** (string) - Optional - Must resolve to an existing user on the account.

### Response
#### Success Response (200)
- **data** (object) - Response data object.
- **data.columnId** (string) - The ID of the column.
- **data.runScope** (string) - The scope applied to the operation.
- **data.status** (string) - The current status of the operation.
- **billing** (object) - Credit usage summary.
- **billing.creditsCharged** (integer) - Total credits charged.
- **billing.resultsReturned** (integer) - Number of successful results returned.

#### Error Response (400)
- **statusCode** (integer) - HTTP status code.
- **message** (string) - Error message.
- **errors** (array) - Detailed error messages.
```

--------------------------------

### Available API Categories

Source: https://docs.lusha.com/apis/openapi/section/available-endpoints

A summary of the functional categories available within the Lusha API suite.

```APIDOC
## Available API Categories

| Category | Description |
| --- | --- |
| Search | Find contacts or companies using known identifiers |
| Enrich | Retrieve full profile data for contacts or companies by ID |
| Search & Enrich | Find and retrieve full contact or company data in a single call |
| Prospecting | Filter-based search across contacts and companies |
| Lookalikes | AI-powered recommendations for similar contacts and companies |
| Contacts Tables | Persist, organize, and enrich contacts in reusable tables |
| Companies Tables | Persist, organize, and enrich companies in reusable tables |
| Signals | Real-world activity data for contacts and companies |
| Decision Makers | Find the most relevant decision makers across your target accounts |
| Website Visitors | Companies ranked by website-visit signals for your tracked domains |
| Filters | Discover valid filter values for prospecting |
| Webhooks | Real-time signal notifications via HTTP callbacks |
| Account | Usage, credits, rate limits, and pricing |
```

--------------------------------

### GET /v3/contacts/prospecting/filters/{filterType}

Source: https://docs.lusha.com/apis/openapi/filters/getcontactfiltervalues

Returns valid values for a single contact filter type.

```APIDOC
## GET /v3/contacts/prospecting/filters/{filterType}

### Description
Returns valid values for a single contact filter type.

### Method
GET

### Endpoint
/v3/contacts/prospecting/filters/{filterType}

### Parameters
#### Path Parameters
- **filterType** (string) - Required - Enum: "departments", "seniority", "existingDataPoints", "countries", "locations"

#### Query Parameters
- **query** (string) - Optional - Search query for locations (required if filterType is 'locations')

### Response
#### Success Response (200)
- **values** (any) - Filter values (shape depends on filter type)

#### Error Response (400)
- **statusCode** (integer) - HTTP status code
- **message** (string) - Error message
- **errors** (array) - Detailed error messages
```

--------------------------------

### GET /api/audit-logs/stats

Source: https://docs.lusha.com/apis/openapi/webhooks

Retrieves statistics about webhook delivery performance, including success and failure rates.

```APIDOC
## GET /api/audit-logs/stats

### Description
Retrieves statistics about webhook delivery performance, including success and failure rates.

### Method
GET

### Endpoint
/api/audit-logs/stats

### Parameters
#### Query Parameters
- **startDate** (string) - Optional - Filter statistics from this date (YYYY-MM-DD).
- **endDate** (string) - Optional - Filter statistics up to this date (YYYY-MM-DD).

### Response
#### Success Response (200)
- **totalDeliveries** (integer) - The total number of webhook deliveries attempted.
- **successfulDeliveries** (integer) - The number of successful webhook deliveries.
- **failedDeliveries** (integer) - The number of failed webhook deliveries.
- **successRate** (number) - The percentage of successful deliveries.

#### Response Example
{
  "totalDeliveries": 100,
  "successfulDeliveries": 95,
  "failedDeliveries": 5,
  "successRate": 0.95
}

### Error Handling
- **401 Unauthorized**: Returned if the API key is invalid or missing.
- **403 Forbidden**: Returned if the user does not have permission to access delivery statistics.
```

--------------------------------

### POST /v3/companies/prospecting

Source: https://docs.lusha.com/apis/openapi/prospecting

Search for companies that match your target market using rich filter criteria such as size, revenue, industry, and technologies.

```APIDOC
## POST /v3/companies/prospecting

### Description
Search for companies that match your target market using rich filter criteria. Results are paginated up to 50,000 total.

### Method
POST

### Endpoint
/v3/companies/prospecting

### Parameters
#### Request Body
- **tableId** (string) - Optional - The ID of an existing table to persist matching results into.
```

--------------------------------

### GET /api/account/secret

Source: https://docs.lusha.com/apis/openapi/webhooks/getaccountsecret.md

Retrieves the current account webhook secret used for verifying webhook events.

```APIDOC
## GET /api/account/secret

### Description
Retrieve the current account webhook secret.

### Method
GET

### Endpoint
https://api.lusha.com/api/account/secret

### Security
ApiKeyAuth

### Response
#### Success Response (200)
- **secret** (string) - Current account webhook secret

#### Response Example
{
  "secret": "whsec_abc123def456ghi789jkl012mno345pqr678stu901vwx234yz"
}

#### Error Response (401)
- **statusCode** (integer) - HTTP status code
- **message** (string) - Error message
- **errors** (array) - Detailed error messages
```
Tokens:
Raw