Skip to main content
Getprospect logo
  • Category: marketing
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 22
  • Triggers: 0
  • Slug: GETPROSPECT
  • Version: 20261101_00

Tools

Slug: GETPROSPECT_APPLY_COUPON_CODETool to apply a coupon code to the user’s account. Use after you need to activate a coupon before using it.

Input Parameters

string
required
The coupon code to apply to the user’s account

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETPROSPECT_CREATE_COMPANYTool to create a new company. Use when you need to add a company record via GetProspect API.

Input Parameters

array
required
Array of property objects to assign to the company

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETPROSPECT_CREATE_CONTACTTool to create a new contact. Use when you need a fresh contact record before associating it to lists.

Input Parameters

array
required
Collection of contact property assignments
array
List of list IDs to associate the new contact with

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETPROSPECT_CREATE_EXPORTCreate an export job for contacts or companies selected by filters or record IDs. A successful request returns an empty response.

Input Parameters

string
required
A human-readable name for this export job
object
Sorting instructions for exported records.
array
Array of filter objects to narrow down the export set
array
Explicit list of record IDs to export; mutually exclusive with filters
string ("csv" | "json" | "xlsx")
Desired file format for the export
string ("company" | "contact")
required
Type of records to export: ‘company’ or ‘contact’
string
Which properties to include in the file (e.g., ‘columns_only’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETPROSPECT_CREATE_LISTTool to create a new contact list. Use when you need to organize contacts into a named list.

Input Parameters

string
required
Name of the new contact list

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETPROSPECT_DELETE_COMPANYTool to delete a company record by its ID. Use when you have confirmed this company should be permanently removed.

Input Parameters

string
required
Company ID to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETPROSPECT_DELETE_CONTACTTool 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

string
required
Unique identifier of the contact to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETPROSPECT_DELETE_DELETE_LISTSDelete multiple contact lists by ID, optionally also deleting contacts within the specified lists.

Input Parameters

array
required
Array of contact list IDs to delete.
boolean
Optional flag to also delete contacts within the specified lists.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETPROSPECT_GET_ACCOUNT_WORKSPACE_LIMITSTool to retrieve workspace limits for the user’s account. Use when you need to check current quotas before bulk operations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETPROSPECT_GET_ALL_COMPANIESTool to retrieve all companies. Use after obtaining a valid API key. Returns a paginated list of companies for the authenticated user.

Input Parameters

string
Field to sort by
string ("ASC" | "DESC")
Sort order: ASC for ascending or DESC for descending
integer
Number of items per page, must be >= 1
integer
Page number to retrieve, must be >= 1

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETPROSPECT_GET_ALL_LISTSTool 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

string
Field to sort by
string ("ASC" | "DESC")
Sort order: ASC for ascending or DESC for descending
integer
Number of items per page, must be >= 1
integer
Page number to retrieve, must be >= 1

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETPROSPECT_GET_SINGLE_COMPANYTool 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

string
required
Unique identifier of the company to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETPROSPECT_GET_SINGLE_CONTACTTool to retrieve details of a single contact. Use when you have the contact ID and need its full record.

Input Parameters

string
required
Unique identifier of the contact to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETPROSPECT_POST_ADD_CONTACTS_TO_LISTTool to add contacts to a specified list. Use when you need to group existing contacts into a list.

Input Parameters

string
required
List ID to add contacts to
array
required
IDs of contacts to add to the list

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETPROSPECT_SEARCH_COMPANIESTool to search for companies by name. Use when you have a company name and need to find matching records.

Input Parameters

string
required
Company name to search for (full or partial)
integer
Maximum number of results to return

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETPROSPECT_SEARCH_CONTACTSTool to search for contacts by filters. Use when you need to find contacts matching specific criteria.

Input Parameters

string
Field to sort by (e.g., ‘createdAt’, ‘email’).
string ("ASC" | "DESC")
Sort direction: ASC for ascending or DESC for descending.
Free-text search settings for contacts.
array
List of filter conditions for contacts.
integer
Number of items per page, must be >= 1.
integer
Page number to retrieve, must be >= 1.
boolean
Whether to include related entities in the response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETPROSPECT_SEARCH_CONTACTS_RELATED_TO_LISTTool to search contacts in a specific list. Use when you need to filter contacts associated with a given list.

Input Parameters

string
Field to sort by
string ("ASC" | "DESC")
Sort order: ASC for ascending or DESC for descending
string
required
Unique identifier of the contact list to search within
integer
Number of items per page, must be >= 1
integer
Page number to retrieve, must be >= 1

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETPROSPECT_SEARCH_THROUGH_LISTS_BY_NAMETool 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

string
required
Substring or full name to search for in contact lists
string
Field to sort by
string ("ASC" | "DESC")
Sort order: ASC for ascending or DESC for descending
integer
Number of items per page, must be >= 1
integer
Page number to retrieve, must be >= 1

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETPROSPECT_UPDATE_COMPANYTool to update details of an existing company. Use when you need to modify company properties after confirming the company exists.

Input Parameters

string
required
Unique identifier of the company to update
array
required
Array of company property updates

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETPROSPECT_UPDATE_CONTACTTool 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

string
required
Unique identifier of the contact to update.
array
List of contact properties to update; each with a property name and new value.
array
List of list IDs to associate the contact with.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETPROSPECT_UPDATE_LISTTool to update a contact list’s name. Use when you need to rename an existing list.

Input Parameters

string
required
New name for the contact list
string
required
Unique identifier of the contact list to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETPROSPECT_VERIFY_EMAIL_ADDRESSVerify an email address’s deliverability and return its verification status.

Input Parameters

string
required
Email address to verify

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not