> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Getprospect

> Find anyone's business email address. GetProspect provides email discovery and verification from LinkedIn.

![Getprospect logo](https://mintcdn.com/composio-preview/GL28i3tBlbEbBd-f/images/toolkits/getprospect.svg?fit=max\&auto=format\&n=GL28i3tBlbEbBd-f\&q=85\&s=e51dcfe1bcfcead008426ebb32260f24)

* **Category:** marketing
* **Auth:** API\_KEY
* **Composio-managed OAuth available?** N/A
* **Tools:** 22
* **Triggers:** 0
* **Slug:** `GETPROSPECT`
* **Version:** 20261101\_00

## Tools

> [accordion] Apply Coupon Code
>
> **Slug:** `GETPROSPECT_APPLY_COUPON_CODE`
>
> Tool to apply a coupon code to the user's account. Use after you need to activate a coupon before using it.
>
> #### Input Parameters
>
> **coupon\_code** `string` *required*
>
> The coupon code to apply to the user's account
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Company
>
> **Slug:** `GETPROSPECT_CREATE_COMPANY`
>
> Tool to create a new company. Use when you need to add a company record via GetProspect API.
>
> #### Input Parameters
>
> **properties** `array` *required*
>
> Array of property objects to assign to the company
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Contact
>
> **Slug:** `GETPROSPECT_CREATE_CONTACT`
>
> Tool to create a new contact. Use when you need a fresh contact record before associating it to lists.
>
> #### Input Parameters
>
> **properties** `array` *required*
>
> Collection of contact property assignments
>
> **listRelations** `array`
>
> List of list IDs to associate the new contact with
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Export
>
> **Slug:** `GETPROSPECT_CREATE_EXPORT`
>
> Create an export job for contacts or companies selected by filters or record IDs. A successful request returns an empty response.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> A human-readable name for this export job
>
> **sort** `object`
>
> Sorting instructions for exported records.
>
> **filters** `array`
>
> Array of filter objects to narrow down the export set
>
> **itemIds** `array`
>
> Explicit list of record IDs to export; mutually exclusive with filters
>
> **fileFormat** `string ("csv" | "json" | "xlsx")`
>
> Desired file format for the export
>
> **sourceType** `string ("company" | "contact")` *required*
>
> Type of records to export: 'company' or 'contact'
>
> **includeProperties** `string`
>
> Which properties to include in the file (e.g., 'columns\_only')
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Contact List
>
> **Slug:** `GETPROSPECT_CREATE_LIST`
>
> Tool to create a new contact list. Use when you need to organize contacts into a named list.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Name of the new contact list
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Company
>
> **Slug:** `GETPROSPECT_DELETE_COMPANY`
>
> Tool to delete a company record by its ID. Use when you have confirmed this company should be permanently removed.
>
> #### Input Parameters
>
> **company\_id** `string` *required*
>
> Company ID to delete
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Contact
>
> **Slug:** `GETPROSPECT_DELETE_CONTACT`
>
> Tool to delete a contact record by its ID. Use when you need to remove a contact; ensure the contact ID exists before calling.
>
> #### Input Parameters
>
> **contact\_id** `string` *required*
>
> Unique identifier of the contact to delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Multiple Contact Lists
>
> **Slug:** `GETPROSPECT_DELETE_DELETE_LISTS`
>
> Delete multiple contact lists by ID, optionally also deleting contacts within the specified lists.
>
> #### Input Parameters
>
> **listIds** `array` *required*
>
> Array of contact list IDs to delete.
>
> **deleteContacts** `boolean`
>
> Optional flag to also delete contacts within the specified lists.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get account workspace limits
>
> **Slug:** `GETPROSPECT_GET_ACCOUNT_WORKSPACE_LIMITS`
>
> Tool to retrieve workspace limits for the user's account. Use when you need to check current quotas before bulk operations.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get All Companies
>
> **Slug:** `GETPROSPECT_GET_ALL_COMPANIES`
>
> Tool to retrieve all companies. Use after obtaining a valid API key. Returns a paginated list of companies for the authenticated user.
>
> #### Input Parameters
>
> **sort** `string`
>
> Field to sort by
>
> **order** `string ("ASC" | "DESC")`
>
> Sort order: ASC for ascending or DESC for descending
>
> **pageSize** `integer`
>
> Number of items per page, must be >= 1
>
> **pageNumber** `integer`
>
> Page number to retrieve, must be >= 1
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get All Contact Lists
>
> **Slug:** `GETPROSPECT_GET_ALL_LISTS`
>
> Tool to retrieve all prospect contact lists. Use when you need to list all existing contact lists for an account. Returns a paginated list of contact lists.
>
> #### Input Parameters
>
> **sort** `string`
>
> Field to sort by
>
> **order** `string ("ASC" | "DESC")`
>
> Sort order: ASC for ascending or DESC for descending
>
> **pageSize** `integer`
>
> Number of items per page, must be >= 1
>
> **pageNumber** `integer`
>
> Page number to retrieve, must be >= 1
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Single Company
>
> **Slug:** `GETPROSPECT_GET_SINGLE_COMPANY`
>
> Tool to retrieve details of a single company by its ID. Use when you have a valid company ID and need its full details.
>
> #### Input Parameters
>
> **companyId** `string` *required*
>
> Unique identifier of the company to retrieve
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Single Contact
>
> **Slug:** `GETPROSPECT_GET_SINGLE_CONTACT`
>
> Tool to retrieve details of a single contact. Use when you have the contact ID and need its full record.
>
> #### Input Parameters
>
> **contact\_id** `string` *required*
>
> Unique identifier of the contact to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Add Contacts to List
>
> **Slug:** `GETPROSPECT_POST_ADD_CONTACTS_TO_LIST`
>
> Tool to add contacts to a specified list. Use when you need to group existing contacts into a list.
>
> #### Input Parameters
>
> **list\_id** `string` *required*
>
> List ID to add contacts to
>
> **contactsIds** `array` *required*
>
> IDs of contacts to add to the list
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search Companies
>
> **Slug:** `GETPROSPECT_SEARCH_COMPANIES`
>
> Tool to search for companies by name. Use when you have a company name and need to find matching records.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Company name to search for (full or partial)
>
> **limit** `integer`
>
> Maximum number of results to return
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search Contacts
>
> **Slug:** `GETPROSPECT_SEARCH_CONTACTS`
>
> Tool to search for contacts by filters. Use when you need to find contacts matching specific criteria.
>
> #### Input Parameters
>
> **sort** `string`
>
> Field to sort by (e.g., 'createdAt', 'email').
>
> **order** `string ("ASC" | "DESC")`
>
> Sort direction: ASC for ascending or DESC for descending.
>
> **search** `object`
>
> Free-text search settings for contacts.
>
> **filters** `array`
>
> List of filter conditions for contacts.
>
> **pageSize** `integer`
>
> Number of items per page, must be >= 1.
>
> **pageNumber** `integer`
>
> Page number to retrieve, must be >= 1.
>
> **includeRelations** `boolean`
>
> Whether to include related entities in the response.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search Contacts in List
>
> **Slug:** `GETPROSPECT_SEARCH_CONTACTS_RELATED_TO_LIST`
>
> Tool to search contacts in a specific list. Use when you need to filter contacts associated with a given list.
>
> #### Input Parameters
>
> **sort** `string`
>
> Field to sort by
>
> **order** `string ("ASC" | "DESC")`
>
> Sort order: ASC for ascending or DESC for descending
>
> **list\_id** `string` *required*
>
> Unique identifier of the contact list to search within
>
> **pageSize** `integer`
>
> Number of items per page, must be >= 1
>
> **pageNumber** `integer`
>
> Page number to retrieve, must be >= 1
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search Lists by Name
>
> **Slug:** `GETPROSPECT_SEARCH_THROUGH_LISTS_BY_NAME`
>
> Tool to search contact lists by name. Use when you need to find lists that match a specific name. Returns a paginated list of matching contact lists.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Substring or full name to search for in contact lists
>
> **sort** `string`
>
> Field to sort by
>
> **order** `string ("ASC" | "DESC")`
>
> Sort order: ASC for ascending or DESC for descending
>
> **pageSize** `integer`
>
> Number of items per page, must be >= 1
>
> **pageNumber** `integer`
>
> Page number to retrieve, must be >= 1
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Company
>
> **Slug:** `GETPROSPECT_UPDATE_COMPANY`
>
> Tool to update details of an existing company. Use when you need to modify company properties after confirming the company exists.
>
> #### Input Parameters
>
> **companyId** `string` *required*
>
> Unique identifier of the company to update
>
> **properties** `array` *required*
>
> Array of company property updates
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Contact
>
> **Slug:** `GETPROSPECT_UPDATE_CONTACT`
>
> Tool to update details of an existing contact. Use when you have the contact ID and need to modify its properties or list assignments.
>
> #### Input Parameters
>
> **contact\_id** `string` *required*
>
> Unique identifier of the contact to update.
>
> **properties** `array`
>
> List of contact properties to update; each with a property name and new value.
>
> **list\_relations** `array`
>
> List of list IDs to associate the contact with.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Contact List
>
> **Slug:** `GETPROSPECT_UPDATE_LIST`
>
> Tool to update a contact list's name. Use when you need to rename an existing list.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> New name for the contact list
>
> **list\_id** `string` *required*
>
> Unique identifier of the contact list to update
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Verify Email Address
>
> **Slug:** `GETPROSPECT_VERIFY_EMAIL_ADDRESS`
>
> Verify an email address's deliverability and return its verification status.
>
> #### Input Parameters
>
> **email** `string` *required*
>
> Email address to verify
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
