NagentArtefacts
Dev & Technology
Enterprise and White Glove
Company
Getprospect connects to a Nagent workspace with an API key. Once it is connected, agents can call 22 Getprospect actions, such as "Create Company", "Create Contact" and "Create Export". Nothing is enabled on connect: each action is allowed one at a time, and an action with side effects runs or waits for a person according to the agent's level.
Every operation an agent can call against Getprospect, with input parameters and output schema.
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
The coupon code to apply to the user's account
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GETPROSPECT_CREATE_COMPANYTool to create a new company. Use when you need to add a company record via GetProspect API.
Input parameters
Array of property objects to assign to the company
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GETPROSPECT_CREATE_CONTACTTool to create a new contact. Use when you need a fresh contact record before associating it to lists.
Input parameters
Collection of contact property assignments
List of list IDs to associate the new contact with
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GETPROSPECT_CREATE_EXPORTTool 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
A human-readable name for this export job
Sorting instructions for exported records.
Array of filter objects to narrow down the export set
Explicit list of record IDs to export; mutually exclusive with filters
Desired file format for the export
Type of records to export: 'company' or 'contact'
Which properties to include in the file (e.g., 'columns_only')
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GETPROSPECT_CREATE_LISTTool to create a new contact list. Use when you need to organize contacts into a named list.
Input parameters
Name of the new contact list
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GETPROSPECT_DELETE_COMPANYTool to delete a company record by its ID. Use when you have confirmed this company should be permanently removed.
Input parameters
Company ID to delete
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Unique identifier of the contact to delete.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GETPROSPECT_DELETE_DELETE_LISTSTool 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
Array of contact list IDs to delete.
Optional flag to also delete contacts within the specified lists.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Field to sort by
Sort order: ASC for ascending or DESC for descending
Number of items per page, must be >= 1
Page number to retrieve, must be >= 1
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Field to sort by
Sort order: ASC for ascending or DESC for descending
Number of items per page, must be >= 1
Page number to retrieve, must be >= 1
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Unique identifier of the company to retrieve
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Unique identifier of the contact to retrieve.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
List ID to add contacts to
IDs of contacts to add to the list
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GETPROSPECT_SEARCH_COMPANIESTool to search for companies by name. Use when you have a company name and need to find matching records.
Input parameters
Company name to search for (full or partial)
Maximum number of results to return
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GETPROSPECT_SEARCH_CONTACTSTool to search for contacts by filters. Use when you need to find contacts matching specific criteria.
Input parameters
Field to sort by (e.g., 'createdAt', 'email').
Sort direction: ASC for ascending or DESC for descending.
Free-text search settings for contacts.
List of filter conditions for contacts.
Number of items per page, must be >= 1.
Page number to retrieve, must be >= 1.
Whether to include related entities in the response.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Field to sort by
Sort order: ASC for ascending or DESC for descending
Unique identifier of the contact list to search within
Number of items per page, must be >= 1
Page number to retrieve, must be >= 1
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Substring or full name to search for in contact lists
Field to sort by
Sort order: ASC for ascending or DESC for descending
Number of items per page, must be >= 1
Page number to retrieve, must be >= 1
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Unique identifier of the company to update
Array of company property updates
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Unique identifier of the contact to update.
List of contact properties to update; each with a property name and new value.
List of list IDs to associate the contact with.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GETPROSPECT_UPDATE_LISTTool to update a contact list's name. Use when you need to rename an existing list.
Input parameters
New name for the contact list
Unique identifier of the contact list to update
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GETPROSPECT_VERIFY_EMAIL_ADDRESSTool to verify an email's deliverability. Use after capturing an email to ensure it's valid.
Input parameters
Email address to verify
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
Agents can call 22 Getprospect actions on Nagent, including "Create Company", "Create Contact" and "Create Export". Create Company: Create a new company. Each action is listed on this page with its input parameters and its output.
Getprospect connects with an API key, under your workspace's own connection. Nothing is enabled on connect: each action is allowed one at a time and can be scoped to the agents that need it.
Create Company takes 1 required input: properties. It returns data, error and successful.