Getprospect integration: operations for AI agents
Getprospect connects to Type.com as an integration. This page lists the 71 operations documented for Claude and Codex in Type.com: 33 read, 30 write, 8 destructive.
About Getprospect
Find anyone's business email address. GetProspect provides email discovery and verification from LinkedIn.
Categories: Marketing & Social
How to connect Getprospect to Type.com
- Access
- Organization connection: one shared account for the workspace.
To add the connection, follow the steps in Space connections.
Documented operations
71 operations. Your connection's permissions determine which operations are available. API references describe the vendor surface; they do not expand your connection's credentials or access.
71 operations listed.
People
- Read
Get a Person
Read one person by GetProspect id: the People Enrich profile, with your workspace's saved block and edits and any email or phone your workspace already owns. Costs no credits: it never reveals or charges anything - to reveal an email or a phone, call People Enrich.
- Read
Preview Save Credits
The free preview of POST /v2/people/save (data: the same items, by id or LinkedIn URL) or of a whole search save (filters + optional excludeids / limit), exactly one of the two.
- Write
Edit a Saved Person
Sets or clears your workspace's own first name, last name, email and phone for a person it saved; every People answer then serves them to your workspace in place of ours.
- Write
People Bulk Enrich
Enrich up to 50 people in one request. Each item takes the same identifiers as People Enrich and is matched independently (strongest identifier wins); the response buckets items into matched, notmatched and invalid, echoing each item's identifier so you can correlate results.
- Write
People Enrich
Retrieve the full profile of one person you already know - identity, location, work history and contact fields.
- Write
Enrich Mobiles for a Search
Looks up mobile numbers for everyone a filter set matches, up to 25000 people, skipping people your workspace already revealed a number for. Answers 202 with a Job and Location: /v2/jobs/{id}; poll it until it is done (a notification is sent too).
- Write
Save People
Saves up to 500 people into 1-20 of your v2 lists, by GetProspect id or by LinkedIn profile URL (at most 50 URL items).
- Write
Save a Whole Search
Saves everyone a filter set matches (the POST /v2/people/search filter object), up to 25000 people, into 1-20 of your v2 lists. Answers 202 with a Job and Location: /v2/jobs/{id}; poll it until it is done.
- Write
People Search
Search our people database by who a person is, what they do and where they work.
Companies
- Read
Companies Get
Read one company by its GetProspect id, with your workspace's saved block (lists, savedat, name edit). An unknown company answers 404 NOTFOUND. Free: spends no credits; 1 unit of the enrich rate limit, none for a company your workspace saved.
- Write
Edit Saved Company
Set or clear your workspace's own name for a saved company; every read in the workspace then shows it. A string sets the name, null or an empty string clears it, and sending the current value changes nothing. A company the workspace has not saved answers 404 NOTSAVED.
- Write
Companies Bulk Enrich
Enrich up to 50 companies in one request. Each item takes the same identifiers as Companies Enrich and is matched independently (id, then linkedinid, linkedinurl, domain, name); the response buckets items into matched, notmatched and invalid, echoing each item's identifier so yo…
- Write
Companies Enrich
Retrieve the full profile of one company - industry, headcount, locations, domains and LinkedIn data. Look it up by GetProspect id, LinkedIn id or URL, web domain, or name; when several identifiers are sent the strongest wins (id, then linkedinid, linkedinurl, domain, name).
- Write
Companies Save
Save companies into your workspace, optionally into company lists. Send company ids, or identify a company by linkedinid, linkedinurl or domain (at most 50 such items per request). The answer buckets every item into saved, notmatched, invalid and failed, echoing its identifier.
- Write
Companies Search
Search our company database by identity, company attributes and free-text keywords.
- Read
Find Email (GET)
GET equivalent of POST /v2/email/find: the same search, with the inputs as query parameters. Costs 1 email credit per served address the workspace does not already own; 1 enrich rate-limit unit.
- Read
List Email Verifications
List the workspace's bulk email verifications, newest first. Free: no credits. query matches the name, owner is me, anyone or a user id; perpage up to 100.
- Read
Get Email Verification
Read one bulk email verification job; poll it while the job is active. Free: no credits. The same id reads as a generic job at GET /v2/jobs/{id}.
- Read
Get Email Verification Results
Read the results of a completed email verification created from data.emails: one item per address in request order (a repeated address at each of its positions), with its status, provider, domain and freeemail.
- Read
List Verification History
List the workspace's single email verifications (emailverify) of the last 30 days, newest first. Free: no credits.
- Read
Verify Email (GET)
GET equivalent of POST /v2/email/verify: the same check, with the address as a query parameter. Costs 1 email verification credit per valid or invalid verdict, once per address per workspace; 1 enrich rate-limit unit.
- Read
Find Email
Find the verified business email address of a specific person. Costs 1 email credit per served address the workspace does not already own; 1 enrich rate-limit unit.
- Write
Create Email Verification
Create a bulk email verification job from a list of up to 10,000 addresses (data.emails). Costs 1 email verification credit per unique valid-syntax address (counts.billable), charged when the job starts; the unverified remainder is refunded on cancel or failure.
- Write
Start Email Verification
Confirm a counted bulk email verification job and start verifying it. Costs 1 email verification credit per billable row (counts.billable), charged at start; the unverified remainder is refunded on cancel or failure.
- Write
Inspect Email File
Read the head of an uploaded file to pick its email column before creating a bulk verification. Free: no credits. Answers the headers, up to 5 preview rows, the delimiter, the encoding, whether the first row is a header, and the columns that hold email addresses (best first).
- Write
Verify Email
Check whether an email address is deliverable. Costs 1 email verification credit per valid or invalid verdict, once per address per workspace; 1 enrich rate-limit unit.
- Destructive
Cancel Email Verification
Cancel a bulk email verification job and refund the credits of the rows it has not verified. Free: no credits. A job is cancellable while queued, counting, awaitingconfirmation or verifying; the refund is made at most once.
Search
- Read
Search Suggestions
Typeahead suggestions for the open-ended People Search and Company Search filters, plus person and company lookups by name.
- Write
Matching Job Titles
Preview which job titles a boolean / Cartesian expression matches before you search with it. Send the same expression you would pass as personjobtitle.booleansearch and get back the most common matching titles with a count for each.
Enums
- Read
List Filter Enums
Returns every filter vocabulary used by the /v2 search endpoints in a single payload. Useful for building filter UIs at integration time. data maps each enum name to its accepted filter values - a flat array for most (e.g.
- Read
Get Filter Enum
Returns the accepted values for one filter vocabulary as data - a flat array for most, except industries and departments (an object of category - values) and regions (an object of region - member country codes).
Developer
- Read
List Request Logs
The requests your API keys made in the last 15 days, newest first, one keyset page at a time: pass metadata.pagination.nextcursor as before for the next page while hasmore is true.
- Read
Get Rate Limits
The workspace's request rate limits and current usage. Tier, plan name, which channels get a real rejection and whether yours does (enforced), and per bucket (search, enrich, jobs, poll) the limits, the units used in the current minute and UTC day, and the seconds until each win…
Lists
- Read
List Lists
The workspace's people and company lists, most recently updated first unless sortby names a column. Filter by type, owner (me or a user id) and query (a case-insensitive substring of the name). recordscount is what an export of the list would write.
- Read
Get List
One list of the workspace, with its current recordscount. Free: costs no credits.
- Write
Set Company Lists
Sets the lists of a selection of saved companies to exactly listids (1-100 company lists): each selected record ends up in those lists and in no other.
- Write
Create List
Creates an empty people or company list and answers it with 201. The name is trimmed and must be free for that type within the workspace (case-insensitive): a taken name answers 409 alreadyexists with the existingid of the list holding it.
- Write
Rename List
Renames a list (its type cannot change). The new name is trimmed and must be free for the list type within the workspace: a taken name answers 409 alreadyexists with the existingid of the list holding it. Renaming a list to its current name changes nothing.
- Write
Add People to List
Adds people the workspace has already saved to one people list. Never saves, reveals or charges: a person the workspace has not saved comes back notsaved (save them with POST /v2/people/save).
- Write
Set People Lists
Sets the lists of a selection of saved people to exactly listids (1-100 people lists): each selected record ends up in those lists and in no other.
- Destructive
Remove Companies from List
Takes companies out of one company list, by company id. They stay saved, and stay in their other lists. removed counts the companies that were in the list. Safe to repeat. Free: costs no credits.
- Destructive
Delete List
Moves a list to Trash, restorable for 90 days, and takes its records out of it; with withrecords=true the records themselves also move to Trash.
- Destructive
Remove People from List
Takes people out of one people list. They stay saved, and stay in their other lists. removed counts the people who were in the list. Safe to repeat. Free: costs no credits.
Jobs
- Read
Get a Job
Reads any async job of the workspace by id: an export, a CSV enrichment, an email verification, a bulk action (Trash, list moves and deletes) or a save / enrich run over a search.
Enrichments
- Read
List Enrichments
Lists the workspace enrichments, newest first: the ones created through the API and the ones created in the App. Filter by status or source; perpage up to 100. Free; a poll (0 rate-limit units, per-second window only).
- Read
Get Enrichment
Reads one enrichment of the workspace: status, progress, counts, credits used and links. Poll it while the job is active; the same id reads as a generic job at GET /v2/jobs/{id}. Free; a poll (0 rate-limit units, per-second window only).
- Read
Get Enrichment Results
Reads the results of a completed enrichment created through the API, one row per request item in request order, each tagged with its status; matched rows carry the same person / company object the sync bulk enrich returns.
- Write
Create Companies Enrichment
Starts a job that matches up to 10,000 companies (by LinkedIn URL, domain or name) against GetProspect. Free: no credits.
- Write
Create People Enrichment
Starts a job that matches up to 10,000 people against GetProspect and, with enrichemail (the default), reveals and finds their emails; enrichphone adds mobile numbers.
- Destructive
Cancel Enrichment
Cancels an enrichment that is not finished; credits already spent stay spent. A job already completed, failed or cancelled answers 409 invalidstate. Free; a poll (0 rate-limit units, per-second window only).
Trash
- Read
List Trash
Lists the deleted people, companies or lists (kind) of the workspace, newest first, for the 90 days they can be restored. search is a case-insensitive name prefix, since a lower bound on the deletion date; perpage up to 100.
Account
- Read
Get Current User
The person the credential belongs to, the workspace it acts in (with the role read live) and how the request authenticated. Use it as a connection test or a whoami: any credential works (API key, OAuth app, signed-in session). Free. No credits.
Billing
- Read
Get Subscription
The plan, billing cycle, phone add-on, pause and discount of this workspace, so a script can check its plan before it spends. Free: no credits. plan.credits are per unit: a subscription of quantity units has quantity times them.
- Read
Get Credit Balances
The live balance of each credit type, so a script or agent can check what it may spend before it spends. Free: no credits. data. .available equals metadata.credits.
- Read
Get Usage Summary
Credits spent and requests made, from the per-day rollup, over an inclusive UTC day range of at most 62 days. Free: no credits. groupby=day returns a time series; groupby=source one row per channel|action|entity.
Webhooks
- Read
List Webhooks
The workspace's webhook subscriptions, newest first. Secrets are never listed. Free: no credits.
- Read
Get Webhook
One webhook subscription, without its secret. Free: no credits.
- Read
List Webhook Deliveries
Delivery attempts of the last 30 days, newest first: event type, status, attempt number, the coarse outcome of the last attempt and when the next one is due. Free: no credits.
- Write
Create Webhook
Subscribes an https URL on a public host to event types. Answers 201 with the signing secret, shown only here; subscribing the same URL to the same events again, with the same credential, answers 200 with that webhook and its secret, so a retried create never makes a second one.
- Write
Update Webhook
Changes the URL, events, description or status (active / paused). Re-activating a disabled webhook resets its failure counters; one whose creator or API key is gone answers 409 creatorremoved.
- Write
Send Test Event
Sends a signed webhook.test event now and reports whether it was delivered, the HTTP status class and a coarse error code. Works on a paused or disabled webhook too, so a fixed receiver can be checked before re-activating it. 10 per webhook and 30 per workspace per minute.
- Destructive
Delete Webhook
Unsubscribes; deliveries stop at once. Idempotent for the workspace's own webhooks. Also accepts the id of a subscription made through the retired v1 hooks API (older Zapier Zaps), which it stops the same way. Free: no credits.
Blocklist
- Read
List Blocked Companies
Lists the company domains on the workspace's block list, newest first, optionally filtered by a substring of the domain. Free, no credits; spends no rate-limit units, but counts against the per-second window of the search bucket.
- Read
List Blocked People
Lists the person entries of the workspace's block list, newest first, optionally filtered by a substring of the first or last name. Free, no credits; spends no rate-limit units, but counts against the per-second window of the search bucket.
- Write
Block Companies
Adds up to 1,000 company domains to the block list and answers every item in added, alreadyblocked or invalid. A domain or website URL is cleaned to its bare host. A repeat lands in alreadyblocked. Safe to retry: a repeat never writes a second entry.
- Write
Block People
Adds up to 1,000 people to the block list by first and last name, optionally with a LinkedIn profile, and answers every item in added, alreadyblocked or invalid.
- Destructive
Unblock Company
Unblocks the domain an entry blocks: removes every entry of the workspace with the same cleaned domain, and answers their ids. A repeat answers 404. Free, no credits; spends no rate-limit units, but counts against the per-second window of the search bucket.
- Destructive
Unblock Person
Unblocks the person an entry blocks: removes the entry and every other entry of the workspace with the same name, and answers their ids. A repeat answers 404. Free, no credits; spends no rate-limit units, but counts against the per-second window of the search bucket.
Notifications
- Read
List Notifications
List the in-app notifications of your workspace, newest first, with the unread count for the bell in metadata.unreadcount.
- Write
Mark Notifications Read
Mark notifications read, by id or all at once. Send ids (1 to 100 notification ids) or all: true, not both: neither answers 400 missingfield, both 400 conflictingfields, and a malformed id 400 invalidformat. Read state is shared by the workspace, and readat keeps the first read.
Events
- Read
Stream Events
Open the realtime event stream of your workspace (text/event-stream): notifications, credit balance changes, subscription and integration changes.
No operations match.
See How connections work for access and permissions, or browse all integrations.