View as Markdown
Clearbit icon

Clearbit ACTION

Email lookup

This endpoint retrieves a person by email address. See the docs here
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Clearbit account once, then configure and run Email lookup from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "clearbit-email-lookup",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    clearbit: { authProvisionId: "apn_xxxxxxx" },
    email: "Email",
    webhookUrl: "Webhook URL",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Email lookup inputs
Property Type Description
email Email string
The email address to look up.
Required
webhookUrl Webhook URL string
A webhook URL that results will be sent to.
Optional
givenName Given Name string
First name of person.
Optional
familyName Family Name string
Last name of person. If you have this, passing this is strongly recommended to improve match rates.
Optional
ipAddress IP Address string
IP address of the person. If you have this, passing this is strongly recommended to improve match rates.
Optional
location Location string
The city or country where the person resides.
Optional
company Company string
The name of the person's employer.
Optional
companyDomain Company Domain string
The domain for the person's employer.
Optional
linkedin LinkedIn string
The LinkedIn URL for the person.
Optional
twitter Twitter string
The Twitter handle for the person.
Optional
facebook Facebook string
The Facebook URL for the person.
Optional
errorIfNoRecords Handle lack of records found as an error? boolean
Defaults to false. If false and no records are found, the step will still be considered a success. If true and no records are found, the step will return an error and workflow execution will stop.
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
clearbit-email-lookup
Version
0.4.1
App
Clearbit
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes