# Getprospect

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

- **Category:** marketing
- **Auth:** API_KEY
- **Composio Managed App Available?** N/A
- **Tools:** 22
- **Triggers:** 0
- **Slug:** `GETPROSPECT`
- **Version:** 20260312_00

## Tools

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `coupon_code` | string | Yes | The coupon code to apply to the user's account |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `properties` | array | Yes | Array of property objects to assign to the company |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `properties` | array | Yes | Collection of contact property assignments |
| `listRelations` | array | No | List of list IDs to associate the new contact with |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Export

**Slug:** `GETPROSPECT_CREATE_EXPORT`

Tool to create a new export job. Use when you need to export contacts or companies based on filters or specific record IDs. Returns HTTP 201 on success.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | A human-readable name for this export job |
| `sort` | object | No | Sorting instructions for exported records. |
| `filters` | array | No | Array of filter objects to narrow down the export set |
| `itemIds` | array | No | Explicit list of record IDs to export; mutually exclusive with filters |
| `fileFormat` | string ("csv" | "json" | "xlsx") | No | Desired file format for the export |
| `sourceType` | string ("company" | "contact") | Yes | Type of records to export: 'company' or 'contact' |
| `includeProperties` | string | No | Which properties to include in the file (e.g., 'columns_only') |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name of the new contact list |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `company_id` | string | Yes | Company ID to delete |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | string | Yes | Unique identifier of the contact to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Multiple Contact Lists

**Slug:** `GETPROSPECT_DELETE_DELETE_LISTS`

Tool to delete multiple contact lists. Use when you have a set of list IDs and want to remove them in bulk. Use after confirming the lists to delete.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `listIds` | array | Yes | Array of contact list IDs to delete. |
| `deleteContacts` | boolean | No | Optional flag to also delete contacts within the specified lists. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string | No | Field to sort by |
| `order` | string ("ASC" | "DESC") | No | Sort order: ASC for ascending or DESC for descending |
| `pageSize` | integer | No | Number of items per page, must be >= 1 |
| `pageNumber` | integer | No | Page number to retrieve, must be >= 1 |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `companyId` | string | Yes | Unique identifier of the company to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | string | Yes | Unique identifier of the contact to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `list_id` | string | Yes | List ID to add contacts to |
| `contactsIds` | array | Yes | IDs of contacts to add to the list |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Company name to search for (full or partial) |
| `limit` | integer | No | Maximum number of results to return |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string | No | Field to sort by (e.g., 'createdAt', 'email'). |
| `order` | string ("ASC" | "DESC") | No | Sort direction: ASC for ascending or DESC for descending. |
| `search` | object | No | Free-text search settings for contacts. |
| `filters` | array | No | List of filter conditions for contacts. |
| `pageSize` | integer | No | Number of items per page, must be >= 1. |
| `pageNumber` | integer | No | Page number to retrieve, must be >= 1. |
| `includeRelations` | boolean | No | Whether to include related entities in the response. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string | No | Field to sort by |
| `order` | string ("ASC" | "DESC") | No | Sort order: ASC for ascending or DESC for descending |
| `list_id` | string | Yes | Unique identifier of the contact list to search within |
| `pageSize` | integer | No | Number of items per page, must be >= 1 |
| `pageNumber` | integer | No | Page number to retrieve, must be >= 1 |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Substring or full name to search for in contact lists |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `companyId` | string | Yes | Unique identifier of the company to update |
| `properties` | array | Yes | Array of company property updates |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | string | Yes | Unique identifier of the contact to update. |
| `properties` | array | No | List of contact properties to update; each with a property name and new value. |
| `listRelations` | array | No | List of list IDs to associate the contact with. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | New name for the contact list |
| `list_id` | string | Yes | Unique identifier of the contact list to update |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Verify Email Address

**Slug:** `GETPROSPECT_VERIFY_EMAIL_ADDRESS`

Tool to verify an email's deliverability. Use after capturing an email to ensure it's valid.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | Yes | Email address to verify |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |