> ## Documentation Index > Fetch the complete documentation index at: https://developer.instantly.ai/llms.txt > Use this file to discover all available pages before exploring further. # Turn local businesses into leads > Starts converting the businesses matching `filters` into up to `count` leads, each with a verified email, in one lead list or one campaign. Runs in the background: read its progress with `GET /local-business-search/convert/{id}`. Costs 2 credits per lead created; businesses without an email cost nothing, and a workspace may scan up to 20000 of them a day (429 `local_business_convert_daily_limit`). Answers 402 when the balance cannot pay for one lead. A request repeated with the same `idempotency_key` returns the same conversion. `campaign_name` also needs the `campaigns:create` scope. Requires one of the following scopes: `supersearch_enrichments:create`, `supersearch_enrichments:all`, `all:create`, `all:all` ## OpenAPI ````yaml https://api.instantly.ai/openapi/api_v2.json post /api/v2/local-business-search/convert openapi: 3.1.0 info: title: API Explorer description: >- The entire API V2 documentation is interactive and can be tested here. To the right side of every endpoint you will see a box with an example request. You can click on the "Try it" button to send a request to the server right from the docs. You will need to provide an API key by clicking the `ApiKeyAuth_token` blue text. version: 2.0.0 servers: - url: https://api.instantly.ai description: Instantly API Server security: - ApiKeyAuth: [] tags: - name: Analytics description: Endpoints related to analytics x-group: Analytics - name: OAuth description: >- OAuth authentication endpoints for connecting Google and Microsoft email accounts x-group: OAuth - name: Account description: An email account that can be used to send campaigns x-group: Account - name: Campaign description: A campaign that can be sent to a list of recipients x-group: Campaign - name: Email description: >- A campaign email, a reply, a manually sent email, or any other email that's visible in the Unibox x-group: Email - name: EmailVerification description: A single email verification x-group: Email Verification - name: LeadList description: A list used to store leads x-group: Lead List - name: InboxPlacementTest description: An inbox placement test x-group: Inbox Placement Test - name: InboxPlacementAnalytics description: Analytics data for individual emails in inbox placement tests x-group: Inbox Placement Analytics - name: InboxPlacementBlacklistAndSpamAssassinReport description: Report data for an inbox placement test x-group: Inbox Placement Blacklist And SpamAssassin Report - name: AIInboxManager description: An AI Inbox Manager agent x-group: AI Inbox Manager - name: AIDeliverabilityAgent description: An AI Deliverability Agent x-group: AI Deliverability Agent - name: AILeadFinderAgent description: An AI Lead Finder Agent x-group: AI Lead Finder Agent - name: LocalBusiness description: >- A local business found by the Local businesses search. Search businesses by category and location, then convert them into leads with a verified email in a lead list or a campaign. x-group: Local Business - name: Creator description: >- A social media creator found by the Creators search. Search creators by platform, niche, audience and location, then convert them into leads with their email. x-group: Creator - name: APIKey description: API Key x-group: API Key - name: AccountCampaignMapping description: Account Campaign Mapping x-group: Account Campaign Mapping - name: Lead description: A lead entity representing an individual lead x-group: Lead - name: BackgroundJob description: A background job that can be used to perform long-running tasks x-group: Background Job - name: CustomTag description: >- A custom tag for organizing and categorizing accounts and campaigns. You can use them as filters in apis that list accounts and campaigns. x-group: Custom Tag - name: CustomTagMapping description: >- This entity represents a tag being assigned to a specific campaign or email account. When an email account is assigned a tag, a new custom tag mapping entry is created, which connects the tag (`tag_id` field) with the email account (`resource_id` field). You can use it to see which tag si connected to which resource. x-group: Custom Tag Mapping - name: BlockListEntry description: A blocked email or domain x-group: Block List Entry - name: LeadLabel description: A custom label for categorizing and managing leads x-group: Lead Label - name: Workspace description: A workspace entity representing a workspace x-group: Workspace - name: SuperSearchEnrichment description: >- An enrichment can take different forms, such as email enrichment or LinkedIn enrichment. Leads may be imported from SuperSearch using the dedicated endpoint, or enriched directly within a list or campaign by attaching an enrichment to it. x-group: SuperSearch Enrichment - name: WorkspaceGroupMember description: >- A member of a workspace group. You can use the endpoints within this entity to manage the members of a workspace group. x-group: Workspace Group Member - name: WorkspaceMember description: A member of a workspace with associated user details x-group: Workspace Member - name: CampaignSubsequence description: A subsequence entity representing a follow-up sequence x-group: Campaign Subsequence - name: AuditLog description: Audit log records for tracking system activities x-group: Audit Log - name: AISalesAgent description: >- An AI Sales Development Representative that autonomously manages outreach campaigns x-group: AI Sales Agent - name: Webhook description: A webhook subscription for receiving event notifications x-group: Webhook - name: WebhookEvent description: A webhook event that was sent or attempted to be sent x-group: Webhook Event - name: DFYEmailAccountOrder description: A Done-For-You email account order x-group: DFY Email Account Order - name: DomainForwarding description: Web forwarding configuration for a domain ordered through Instantly x-group: Domain Forwarding - name: CustomPromptTemplate description: Custom prompt templates for creating custom prompts x-group: Custom Prompt Template - name: SalesFlow description: >- Manages how sales users view and interact with campaign and lead lists within the sales flow. x-group: Sales Flow - name: EmailTemplate description: A campaign email template x-group: Email Template - name: WorkspaceBilling description: Workspace Billing x-group: Workspace Billing - name: CRMActions description: CRM related actions x-group: CRM Actions - name: EngageItem description: >- A unified Engage item representing a campaign, AI agent, automation workflow, broadcast, or journey. x-group: Engage Item paths: /api/v2/local-business-search/convert: post: tags: - LocalBusiness summary: Turn local businesses into leads description: >- Starts converting the businesses matching `filters` into up to `count` leads, each with a verified email, in one lead list or one campaign. Runs in the background: read its progress with `GET /local-business-search/convert/{id}`. Costs 2 credits per lead created; businesses without an email cost nothing, and a workspace may scan up to 20000 of them a day (429 `local_business_convert_daily_limit`). Answers 402 when the balance cannot pay for one lead. A request repeated with the same `idempotency_key` returns the same conversion. `campaign_name` also needs the `campaigns:create` scope. Requires one of the following scopes: `supersearch_enrichments:create`, `supersearch_enrichments:all`, `all:create`, `all:all` operationId: convertLocalBusinesses requestBody: content: application/json: schema: type: object additionalProperties: false required: - filters - count - idempotency_key properties: filters: type: object additionalProperties: true description: >- A search needs a category, a query or a name, and a location (a city, a state, or `lat`/`long`). properties: query: type: - string - 'null' description: Free text, used only when no category is set categories: type: - array - 'null' items: type: string description: Exact business categories example: - dentist location: type: - object - 'null' additionalProperties: false properties: label: type: - string - 'null' examples: - Austin, TX description: What the location filter shows example: Austin, TX country: type: - string - 'null' examples: - US example: US state: type: - string - 'null' examples: - TX example: TX city: type: - string - 'null' examples: - Austin example: Austin lat: type: - number - 'null' examples: - 30.2672 example: 30.2672 long: type: - number - 'null' examples: - -97.7431 example: -97.7431 radius_km: type: - number - 'null' examples: - 10 description: Searched around `lat`/`long` example: 10 description: >- A city or state, or a point and a radius. Build it from `GET /local-business-search/places`. keywords: type: - array - 'null' items: type: string description: Ranks businesses that mention these first name: type: - string - 'null' description: Part of the business name min_rating: type: - number - 'null' description: 0 to 5 max_rating: type: - number - 'null' description: 0 to 5 min_reviews: type: - number - 'null' max_reviews: type: - number - 'null' min_locations: type: - integer - 'null' max_locations: type: - integer - 'null' description: 1 leaves chains and franchises out exclude_keywords: type: - array - 'null' items: type: string opened_within_months: type: - integer - 'null' description: Only businesses that opened within this many months updated_within_months: type: - integer - 'null' description: Only records refreshed within this many months count: type: integer minimum: 1 maximum: 1000000 campaign_id: type: string format: uuid campaign_name: type: string minLength: 1 maxLength: 255 description: >- Creates a draft campaign with this name and the default schedule, and adds the leads to it. list_id: type: string format: uuid list_name: type: string minLength: 1 maxLength: 255 idempotency_key: type: string minLength: 8 maxLength: 80 required: true responses: '200': description: Default Response content: application/json: schema: type: object additionalProperties: false required: - job properties: job: type: object additionalProperties: false required: - id - status - requested - scanned - created - lookup_pending - verify_pending - verifying_count - credits_spent - list_id - campaign_id - updated_at properties: id: type: string format: uuid description: >- Read the conversion with `GET /local-business-search/convert/{id}` status: type: string enum: - running - done - out_of_credits - daily_limit - failed description: '`running` until the conversion ends' requested: type: integer description: Leads asked for scanned: type: integer description: Businesses read so far created: type: integer description: >- Leads created, each with an email; each costs 2 credits lookup_pending: type: integer description: Businesses whose email is being looked up right now verify_pending: type: integer description: Emails being verified before the leads are written verifying_count: type: integer description: Leads of a finished conversion still being verified credits_spent: type: number list_id: type: - 'null' - string format: uuid campaign_id: type: - 'null' - string format: uuid updated_at: type: number description: Unix time in milliseconds error_code: type: string pool_exhausted: type: boolean description: >- Every matching business was read: a conversion that ended short could not have found more '202': description: Default Response content: application/json: schema: type: object additionalProperties: false required: - job properties: job: type: object additionalProperties: false required: - id - status - requested - scanned - created - lookup_pending - verify_pending - verifying_count - credits_spent - list_id - campaign_id - updated_at properties: id: type: string format: uuid description: >- Read the conversion with `GET /local-business-search/convert/{id}` status: type: string enum: - running - done - out_of_credits - daily_limit - failed description: '`running` until the conversion ends' requested: type: integer description: Leads asked for scanned: type: integer description: Businesses read so far created: type: integer description: >- Leads created, each with an email; each costs 2 credits lookup_pending: type: integer description: Businesses whose email is being looked up right now verify_pending: type: integer description: Emails being verified before the leads are written verifying_count: type: integer description: Leads of a finished conversion still being verified credits_spent: type: number list_id: type: - 'null' - string format: uuid campaign_id: type: - 'null' - string format: uuid updated_at: type: number description: Unix time in milliseconds error_code: type: string pool_exhausted: type: boolean description: >- Every matching business was read: a conversion that ended short could not have found more '400': description: >- The request is invalid (e.g. missing required fields, invalid field values, or an invalid state for the operation) content: application/json: schema: type: object properties: statusCode: type: number enum: - 400 examples: - 400 example: 400 code: type: string description: >- Fastify's validation code (`FST_ERR_VALIDATION`) or a route-specific error code. examples: - FST_ERR_VALIDATION example: FST_ERR_VALIDATION error: type: string enum: - Bad Request examples: - Bad Request example: Bad Request message: type: string examples: - body must have required property 'name' example: body must have required property 'name' required: - statusCode - error - message '401': description: >- This request is unauthorized (either the Authorization header is missing or invalid, or the API key has been revoked) content: application/json: schema: type: object properties: statusCode: type: number enum: - 401 examples: - 401 example: 401 error: type: string enum: - Unauthorized examples: - Unauthorized example: Unauthorized message: type: string examples: - Missing Authorization header example: Missing Authorization header required: - statusCode - error - message '402': description: Default Response content: application/json: schema: type: object properties: statusCode: type: number example: 402 error: type: string example: Insufficient credits message: type: string example: Insufficient credits creditsRequired: type: number example: 2 creditsAvailable: type: number example: 0 required: - statusCode - error - message '403': description: Default Response content: application/json: schema: type: object additionalProperties: true '404': description: The requested resource was not found content: application/json: schema: type: object properties: statusCode: type: number enum: - 404 examples: - 404 example: 404 error: type: string enum: - Not Found examples: - Not Found example: Not Found message: type: string examples: - Resource not found example: Resource not found required: - statusCode - error - message '429': description: Default Response content: application/json: schema: type: object properties: statusCode: type: number example: 429 error: type: string example: local_business_search_daily_limit message: type: string example: local_business_search_daily_limit code: type: string example: local_business_search_daily_limit required: - statusCode - error - message components: securitySchemes: ApiKeyAuth: type: http scheme: bearer ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.