--- title: Clearbit modules slug: clearbit-modules image: https://make-cxp-documentation.ams3.cdn.digitaloceanspaces.com/apps-center-icons/PREVIEW_DEFAULT.png docTags: createdAt: 2025-03-14T13:19:10.751Z --- After connecting to the Clearbit app, you can use the following modules to build your scenarios. # Person :::ExpandableHeading ## Get a Person or Company Retrieves a person and company simultaneously based on an email address. | **Field** | **Description** | | ------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Connection** | [Create a connection to your Clearbit account.](docId\:fG1DlkZp8wvHZohBYWO3b) | | **Email Address** | Enter the email address to look up. | | **Given Name** | Enter the first name of the person. | | **Family Name** | Enter the last name of the person. If you have this, specifying this is strongly recommended to improve match rates. | | **IP address** | Enter the IP address of the person. If you have this, specifying this is strongly recommended to improve match rates. | | **Location** | The city or country where the person resides. | | **Company** | The name of the person’s company. | | **Company Domain** | The domain of the person’s company. | | **Linked In** | The LinkedIn URL for the person. | | **Twitter** | The Twitter handle for the person. | | **Facebook** | Enter The Facebook URL for the person. | | **Exclude EU related data ?** | Select `exclude eu records` to exclude person records with country data in the EU. Select `exclude eu records or with null country data` to exclude person records with country data in the EU or with null country data. | | **Subscribe to changes for this person ?** | Select the **Yes** option to subscribe to the changes to the person.
If you subscribe, every update of this person's information will trigger a webhook and count as an API call on Clearbit. You can set the webhook URL associated with your account on your [dashboard](https://dashboard.clearbit.com/api). You need the `Watch Changes` trigger module to receive the updated information.
Select **No** to unsubscribe. | ::: :::ExpandableHeading ## Get a Person Retrieves a person by their email address. Alongside the email address you may also provide any additional attributes you have about the person. | **Field** | **Description** | | ------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Connection** | [Create a connection to your Clearbit account.](docId\:fG1DlkZp8wvHZohBYWO3b) | | **Email Address** | Enter the email address to look up. | | **Given Name** | Enter the first name of the person. | | **Family Name** | Enter the last name of the person. If you have this, specifying this is strongly recommended to improve match rates. | | **IP address** | Enter the IP address of the person. If you have this, specifying this is strongly recommended to improve match rates. | | **Location** | The city or country where the person resides. | | **Company** | The name of the person’s company. | | **Company Domain** | The domain of the person’s company. | | **Linked In** | The LinkedIn URL for the person. | | **Twitter** | The Twitter handle for the person. | | **Facebook** | Enter The Facebook URL for the person. | | **Exclude EU related data ?** | Select `exclude eu records` to exclude person records with country data in the EU. Select `exclude eu records or with null country data` to exclude person records with country data in the EU or with null country data. | | **Subscribe to changes for this person ?** | Select the **Yes** option to subscribe to the changes to the person.
If you subscribe, every update of this person's information will trigger a webhook and count as an API call on Clearbit. You can set the webhook URL associated with your account on your [dashboard](https://dashboard.clearbit.com/api). You need the `Watch Changes` trigger module to receive the updated information.
Select **No** to unsubscribe. | ::: # Company :::ExpandableHeading ## Get a Company Retrieves company data via a domain name. | **Field** | **Description** | | ---------------- | ------------------------------------------------------------------------------ | | **Connection** | [Create a connection to your Clearbit account.](docId\:fG1DlkZp8wvHZohBYWO3b) | | **Domain** | Enter the domain of the company’s website. | | **Company name** | Enter the name of the company. | | **Linked In** | Enter the company’s Linkedin URL. | | **Twitter** | Enter the Twitter screen name. | | **Facebook** | Enter the company’s Facebook ID. | ::: :::ExpandableHeading ## Get a Company's Domain Retrieves a company by its domain. | **Field** | **Description** | | -------------- | ------------------------------------------------------------------------------ | | **Connection** | [Create a connection to your Clearbit account.](docId\:fG1DlkZp8wvHZohBYWO3b) | | **Name** | Enter the name of the company you want to retrieve the domain for. | ::: # Other :::ExpandableHeading ## Watch Changes Triggers when a person you are subscribed to is updated. | **Field** | **Description** | | ---------------- | ----------------------------------------------------- | | **Webhook name** | Enter the name for the webhook. | | **Connection** | [Establish a connection to your Clearbit account](#). | ::: :::ExpandableHeading ## Make an API Call Allows you to perform a custom API call. | **Field** | **Description** | | ------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Connection** | [Create a connection to your Clearbit account.](docId\:fG1DlkZp8wvHZohBYWO3b) | | **Choose your API** | Select the API. The [streaming](https://clearbit.com/docs#streaming) version of the API is preferred to ensure synchronous response. | | **URL** | Enter a path relative to `https://{api}.clearbit.com`. E.g. `/v2/companies/flag` | | **Method** | Select the HTTP method you want to use:
- **GET: **to retrieve information for an entry.
- **POST: **to create a new entry.
- **PUT:** to update/replace an existing entry.
- **PATCH: **to make a partial entry update.
- **DELETE: **to delete an entry. | | **Headers** | Enter the desired request headers. You don't have to add authorization headers; we already did that for you. | | **Query String** | Enter the request query string. | | **Body** | Enter the body content for your API call. | :::