openapi: 3.2.0
info:
  title: Lusha API Documentation Buying Group API
  version: ''
  x-logo:
    url: https://www.lusha.com/logo.png
  license:
    name: Proprietary
    url: https://lusha.com/legal/terms
  description: "<blockquote class=\"callout\">\n\n **This is the Lusha API V3 documentation.** \n \n V3 introduces a new search-then-enrich pattern, bulk operations, AI-powered lookalikes, and richer filter capabilities. All endpoints are under `https://api.lusha.com/v3/`.\n\n  For more information on V3, refer to the [Migration Guide](/tutorials/v3-migration-guide).\n\n</blockquote>\n\n  --- \n\nLusha provides a RESTful API for querying a comprehensive dataset of business profiles and company information. Built for teams running prospecting, enrichment, automation, and analytics workflows that need accurate, continuously updated business data. The API supports both real-time and bulk use cases.\n\nUse the Lusha API to **search for new prospects**, **enrich existing records**, **react to real-world changes**, and **expand coverage** with AI-powered lookalike recommendations.\n\n> All API requests must be made over **HTTPS**. All responses are returned in **JSON** format.\n\n--- \n## Available Endpoints\n\n| Category | Description |\n|---|---|\n| [**Search**](#tag/Search) | Find contacts or companies using known identifiers |\n| [**Enrich**](#tag/Enrich) | Retrieve full profile data for contacts or companies by ID |\n| [**Search & Enrich**](#tag/Search-and-Enrich) | Find and retrieve full contact or company data in a single call |\n| [**Prospecting**](#tag/Prospecting) | Filter-based search across contacts and companies |\n| [**Lookalikes**](#tag/Lookalikes) | AI-powered recommendations for similar contacts and companies |\n| [**Buying Group**](#tag/Buying-Group) | Identify decision makers, champions, and end users within target accounts |\n| [**Contacts Tables**](#tag/Contacts-Tables) | Persist, organize, and enrich contacts in reusable tables |\n| [**Companies Tables**](#tag/Companies-Tables) | Persist, organize, and enrich companies in reusable tables |\n| [**Signals**](#tag/Signals) | Real-world activity data for contacts and companies |\n| [**Website Visitors**](#tag/Website-Visits) | Companies ranked by website-visit signals for your tracked domains |\n| [**Filters**](#tag/Filters) | Discover valid filter values for prospecting |\n| [**Webhooks**](#tag/Webhooks) | Real-time signal notifications via HTTP callbacks |\n| [**Account**](#tag/Account) | Usage, credits, rate limits, and pricing |\n\n<blockquote class=\"callout\">\n\n **Waterfall Reveal for Contact Enrichment.**\n\n  Enrich Contacts now supports `waterfallEnabled`. Fall through to your enabled third-party providers when Lusha's own data has no match, for extra reach on hard-to-match contacts. On by default once your account has it turned on - pass `waterfallEnabled: false` to opt a specific call out. [See Enrich Contacts](#operation/enrichContacts).\n\n</blockquote>\n\n---\n\n## Data Source and Privacy\n\n**Lusha is a search platform.** The data provided is not created or directly managed by Lusha. It is sourced from publicly available information and trusted business partners.\n\nFor more details on how we collect and handle data, see our [Privacy Policy](https://lusha.com/legal/privacy-notice/).\n\n---\n\n## Authentication\n\nAll API requests require an **API key** linked to your Lusha account and plan. Pass your key in the `api_key` request header on every call.\n\n> Generate and manage your API key in the [Lusha dashboard](https://dashboard.lusha.com/enrich/api).\n\nStore your API key securely and use it only in **server-side environments**.\n\n---\n\n## Rate Limiting\n\nLusha enforces rate limits on a per-plan basis to ensure fair usage and platform stability. Limits are applied across multiple time windows (per minute, per hour, and per day), and vary depending on your account plan.\n\nRate limits for the **Credit Usage API** differ from standard endpoint limits.\n\n> **Note:** To check your current plan's limits, visit the [Lusha Help Center](https://info.lusha.com/en/articles/163856-all-there-is-to-know-about-lusha-s-api) or contact your account manager.\n\n**Rate Limit Response Headers**\n\n| Header | Description |\n|--------|-------------|\n| `x-rate-limit-daily` | Total requests allowed per day |\n| `x-daily-requests-left` | Requests remaining in your daily quota |\n| `x-daily-usage` | Requests made in the current daily period |\n| `x-rate-limit-hourly` | Total requests allowed per hour |\n| `x-hourly-requests-left` | Requests remaining in your hourly quota |\n| `x-hourly-usage` | Requests made in the current hourly period |\n| `x-rate-limit-minute` | Total requests allowed per minute |\n| `x-minute-requests-left` | Requests remaining in the current minute window |\n| `x-minute-usage` | Requests made in the current minute window |\n\n---\n## Error Codes\n\nLusha uses standard HTTP status codes to indicate the result of each request.\n\n| Code | Name | Description |\n|------|------|-------------|\n| `200` | OK | Request was successful |\n| `400` | Bad Request | Request is malformed or missing required fields |\n| `401` | Unauthorized | API key is missing or invalid |\n| `402` | Payment Required | Insufficient credits or payment needed |\n| `403` | Forbidden | Account is inactive. Contact support@lusha.com |\n| `404` | Not Found | Endpoint or resource does not exist |\n| `429` | Too Many Requests | Rate limit or daily quota exceeded |\n| `451` | Unavailable For Legal Reasons | Request blocked due to GDPR regulations |\n| `499` | Client Closed Request | Request timed out before completing |\n| `5XX` | Server Error | Issue on Lusha's end. Retry with exponential backoff |\n\n**Error Response Format**\n\n```json\n{\n  \"statusCode\": 400,\n  \"message\": \"Invalid request parameters\"\n}\n```\n\n**Tables-specific error codes**\n\n| Code | Status | Meaning |\n|---|---|---|\n| `TABLE_NOT_FOUND` | 404 | The `table_id` does not exist or is not accessible to this account |\n| `COLUMN_NOT_FOUND` | 404 | The `column_id` does not exist on the given table |\n| `TABLE_NAME_CONFLICT` | 409 | A table with this name already exists |\n\nTables error bodies use the shape `{ \"message\": \"...\", \"code\": <status>, ... }` rather than the `statusCode`/`errors` shape used elsewhere in this doc.\n\n**Limits:** up to 500 entity IDs per add/remove call · max 50,000 entities per table · max 500 tables per account · `page` 0–100 · `size` default 100.\n\n**Tips for Handling Errors**\n\n- Verify your API key is correct and active\n- Read the `message` field for specific troubleshooting details\n- For `429` errors, wait before retrying\n- For `5XX` errors, use exponential backoff before retrying\n"
  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: Buying Group
  description: '**Buying Group API:** Identify and prioritize the buying committee within a set of target companies.


    Supply up to 25 companies by `domain` or Lusha company `id`. The model scores and labels each returned contact with a persona role - `decision_maker`, `potential_champion`, or `end_user` - so you can prioritize outreach across the buying committee instead of working one contact at a time.


    Results are lightweight previews grouped by company. Use [Enrich Contacts](#operation/enrichContacts) with the returned `id` to reveal emails and phones.


    > **Billing:** Charged per contact returned via the `buyingGroupContact` action.

    '
  x-tag-expanded: true
paths:
  /v3/contacts/buying-group:
    post:
      tags:
      - Buying Group
      summary: Get Buying Group Contacts
      operationId: getContactsBuyingGroup
      description: 'Identify the buying group within a set of target companies. Supply companies by `domain` or Lusha company `id` - the model scores and labels each returned contact with a persona role.


        **Personas:**

        - `decision_maker` — has budget or sign-off authority

        - `potential_champion` — likely internal advocate for the purchase

        - `end_user` — likely day-to-day user of the product


        Pass `personas` to filter to specific roles, or omit it to get all three. Use `contactsLimit` to cap how many contacts are returned per company (default 60).


        Results are lightweight previews grouped by company. Each contact includes a `has` field listing available data points, a `canReveal` field showing what can be unlocked via Enrich, a `roles` array with the assigned persona(s), and a `score` (0-1) reflecting relevance to the assigned role.


        Use Enrich Contacts with the returned contact `id` to reveal emails and phones.


        > **Billing:** Charged per contact returned via the `buyingGroupContact` action.

        '
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/V3BuyingGroupRequest'
            example:
              companies:
              - clientReferenceId: comp-ref-1
                domain: acme.com
              - clientReferenceId: comp-ref-2
                id: v1.AbCdEfGhIjKlMnOpQrStUvWxYz012345
              personas:
              - decision_maker
              - potential_champion
              contactsLimit: 20
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V3BuyingGroupResponse'
              example:
                requestId: 951d46da-24f9-4608-84bf-5e70a10bf851
                results:
                - companyId: v1.ocoj3UrkPqHcR8yAEosYFTuVXTH282LP
                  contacts:
                  - id: v1.VdKU4HkaDb7CE4CEImoUcm7bxUGUUz-aOQ
                    firstName: Mohammed
                    lastName: Alam
                    jobTitle:
                      title: RF/Analog IC Design Engineer
                      departments:
                      - Engineering & Technical
                      seniority: Non-Manager
                    company:
                      id: v1.ocoj3UrkPqHcR8yAEosYFTuVXTH282LP
                      name: Intel
                      domain: www.intel.com
                    location:
                      country: United States
                      state: Arizona
                      city: Chandler
                    socialLinks:
                      linkedin: https://www.linkedin.com/in/mohammed-alam-83759111
                    has:
                    - firstName
                    - lastName
                    - jobTitle
                    - company
                    - location
                    - socialLinks
                    - phones
                    - previousEmployment
                    - jobStartDate
                    canReveal:
                    - field: phones
                      credits: 5
                    roles:
                    - potential_champion
                    score: 0.8872673511505127
                pagination:
                  page: 0
                  size: 100
                  total: 1
                billing:
                  creditsCharged: 1
                  resultsReturned: 1
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '402':
          $ref: '#/components/responses/PaymentRequired'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
components:
  schemas:
    V3BuyingGroupResponse:
      type: object
      properties:
        requestId:
          type: string
          format: uuid
          example: 951d46da-24f9-4608-84bf-5e70a10bf851
        results:
          type: array
          items:
            $ref: '#/components/schemas/V3BuyingGroupCompanyResult'
        pagination:
          $ref: '#/components/schemas/V3PaginationResponse'
        billing:
          $ref: '#/components/schemas/V3Billing'
    V3BuyingGroupRequest:
      type: object
      required:
      - companies
      properties:
        companies:
          type: array
          items:
            $ref: '#/components/schemas/V3BuyingGroupCompanyItem'
          minItems: 1
          maxItems: 25
        personas:
          type: array
          description: Filter results to specific persona roles. Omit to return all three.
          items:
            type: string
            enum:
            - decision_maker
            - potential_champion
            - end_user
          example:
          - decision_maker
          - potential_champion
        contactsLimit:
          type: integer
          description: Maximum number of contacts returned per company.
          default: 60
          minimum: 1
          example: 20
        pagination:
          type: object
          description: Optional. If omitted, defaults to page 0, size 100.
          properties:
            page:
              type: integer
              minimum: 0
              default: 0
              example: 0
            size:
              type: integer
              minimum: 10
              maximum: 100
              default: 100
              example: 100
    V3CanRevealItem:
      type: object
      description: Indicates a data type that can be revealed and its credit cost
      properties:
        field:
          type: string
          enum:
          - emails
          - phones
          example: emails
        credits:
          type: integer
          description: Credit cost (0 when already revealed for this account)
          example: 1
    V3BuyingGroupContact:
      type: object
      properties:
        id:
          type: string
          example: v1.VdKU4HkaDb7CE4CEImoUcm7bxUGUUz-aOQ
        firstName:
          type: string
          example: Mohammed
        lastName:
          type: string
          example: Alam
        jobTitle:
          type: object
          properties:
            title:
              type: string
              example: RF/Analog IC Design Engineer
            departments:
              type: array
              items:
                type: string
              example:
              - Engineering & Technical
            seniority:
              type: string
              example: Non-Manager
        company:
          type: object
          properties:
            id:
              type: string
              example: v1.ocoj3UrkPqHcR8yAEosYFTuVXTH282LP
            name:
              type: string
              example: Intel
            domain:
              type: string
              example: www.intel.com
        location:
          type: object
          properties:
            country:
              type: string
              example: United States
            state:
              type: string
              example: Arizona
            city:
              type: string
              example: Chandler
        socialLinks:
          type: object
          properties:
            linkedin:
              type: string
              example: https://www.linkedin.com/in/mohammed-alam-83759111
        has:
          type: array
          items:
            type: string
          example:
          - firstName
          - lastName
          - jobTitle
          - company
          - location
          - socialLinks
          - phones
          - previousEmployment
          - jobStartDate
        canReveal:
          type: array
          items:
            $ref: '#/components/schemas/V3CanRevealItem'
        roles:
          type: array
          description: Persona role(s) the model assigned to this contact.
          items:
            type: string
            enum:
            - decision_maker
            - potential_champion
            - end_user
          example:
          - potential_champion
        score:
          type: number
          minimum: 0
          maximum: 1
          description: Relevance score for the assigned role(s).
          example: 0.8872673511505127
        error:
          $ref: '#/components/schemas/V3ItemError'
    V3PaginationResponse:
      type: object
      properties:
        page:
          type: integer
          example: 0
        size:
          type: integer
          example: 25
        total:
          type: integer
    V3BuyingGroupCompanyResult:
      type: object
      properties:
        clientReferenceId:
          type: string
          example: comp-ref-1
        companyId:
          type: string
          example: v1.ocoj3UrkPqHcR8yAEosYFTuVXTH282LP
        contacts:
          type: array
          items:
            $ref: '#/components/schemas/V3BuyingGroupContact'
        error:
          $ref: '#/components/schemas/V3ItemError'
    V3BuyingGroupCompanyItem:
      type: object
      description: Identifies one target company. Provide exactly one of domain or id.
      properties:
        clientReferenceId:
          type: string
          description: Optional caller-supplied token, echoed back on the matching result.
          example: comp-ref-1
        domain:
          type: string
          example: acme.com
        id:
          type: string
          description: Lusha company ID.
          example: v1.AbCdEfGhIjKlMnOpQrStUvWxYz012345
    V3Billing:
      type: object
      description: Credit usage summary for a V3 API request
      properties:
        creditsCharged:
          type: integer
          description: Total credits charged for this request
          example: 3
        resultsReturned:
          type: integer
          description: Number of successful results returned
          example: 1
    V3ItemError:
      type: object
      description: Per-item error in a batch response
      properties:
        code:
          type: string
          enum:
          - NOT_FOUND
          - COMPLIANCE_RESTRICTED
          - ENRICH_FAILED
          - NO_SCORE
          example: NOT_FOUND
        message:
          type: string
          example: Contact not found
    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'
  responses:
    Unauthorized:
      description: Unauthorized - invalid or missing API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            statusCode: 401
            message: Invalid API key
    PaymentRequired:
      description: Payment required - insufficient credits
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            statusCode: 402
            message: Insufficient credits for this operation
    BadRequest:
      description: Bad request - invalid input data
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            statusCode: 400
            message: Invalid request parameters
    Forbidden:
      description: Forbidden - account inactive, V3 access not enabled, or plan does not include this feature
      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
            v3NotEnabled:
              summary: V3 access not enabled
              value:
                statusCode: 403
                message: V3 API access is not enabled for your account
    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:
        x-rate-limit-daily:
          description: Total requests allowed per day
          schema:
            type: integer
        x-daily-requests-left:
          description: Requests remaining in daily quota
          schema:
            type: integer
        x-rate-limit-hourly:
          description: Total requests allowed per hour
          schema:
            type: integer
        x-hourly-requests-left:
          description: Requests remaining in hourly quota
          schema:
            type: integer
        x-rate-limit-minute:
          description: Total requests allowed per minute
          schema:
            type: integer
        x-minute-requests-left:
          description: Requests remaining in current minute window
          schema:
            type: integer
  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.

        '