Get Associated Emails with HubSpot API

Pipedream makes it easy to connect APIs for HubSpot and 2,900+ other apps remarkably fast.

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

Get Associated Emails with the HubSpot API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

Create a workflow to Get Associated Emails with the HubSpot API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the Get Associated Emails action
1. Connect your HubSpot account
2. Select a Associated Object Type
3. Select a Object ID
4. Optional- Configure Additional Properties
5. Optional- Configure Limit
Select a trigger to run your workflow on HTTP requests, schedules or app events
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Integrations#

Get Associated Emails with HubSpot API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + HubSpot

Try it

Get Associated Emails with HubSpot API on New Submission from Typeform API

Typeform + HubSpot

Try it

Get Associated Emails with HubSpot API on New Submission (Instant) from Jotform API

Jotform + HubSpot

Try it

Get Associated Emails with HubSpot API on New Scheduled Tasks from Pipedream API

Pipedream + HubSpot

Try it

Get Associated Emails with HubSpot API on New Download Counts from npm API

npm + HubSpot

Try it

Details#

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Get Associated Emails on HubSpot

Description:Retrieves emails associated with a specific object (contact, company, or deal). [See the documentation](https://developers.hubspot.com/docs/reference/api/crm/search)

Version:0.0.9

Key:hubspot-get-associated-emails

View on GitHub

Code#

import { DEFAULT_EMAIL_PROPERTIES } from "../../common/constants.mjs";
import hubspot from "../../hubspot.app.mjs";

export default {
  key: "hubspot-get-associated-emails",
  name: "Get Associated Emails",
  description:
    "Retrieves emails associated with a specific object (contact, company, or deal). [See the documentation](https://developers.hubspot.com/docs/reference/api/crm/search)",
  version: "0.0.9",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: true,
  },
  type: "action",
  props: {
    hubspot,
    objectType: {
      propDefinition: [
        hubspot,
        "objectType",
        () => ({
          includeCustom: true,
        }),
      ],
      label: "Associated Object Type",
      description: "The type of the object the emails are associated with",
    },
    objectId: {
      type: "string",
      label: "Object ID",
      description: "The ID of the object to get associated emails for",
      propDefinition: [
        hubspot,
        "objectIds",
        ({ objectType }) => ({
          objectType,
        }),
      ],
    },
    additionalProperties: {
      type: "string[]",
      label: "Additional Properties",
      description: "Additional properties to retrieve for the emails",
      optional: true,
    },
    limit: {
      type: "integer",
      label: "Limit",
      description: "Maximum number of emails to retrieve",
      optional: true,
      default: 20,
      min: 1,
      max: 100,
    },
  },
  async run({ $ }) {
    const properties = [
      ...DEFAULT_EMAIL_PROPERTIES,
      ...(this.additionalProperties || []),
    ];

    const {
      objectType, objectId, limit,
    } = this;

    const { results } = await this.hubspot.getAssociations({
      $,
      objectType,
      objectId,
      toObjectType: "emails",
      params: {
        limit,
      },
    });

    if (!results?.length > 0) {
      $.export("$summary", "No emails found with this association");
      return [];
    }

    const emailIds = results.map((association) => ({
      id: association.toObjectId,
    }));

    const { results: emails } = await this.hubspot.batchGetObjects({
      $,
      objectType: "emails",
      data: {
        properties,
        inputs: emailIds,
      },
    });

    // Sort emails by timestamp in descending order (most recent first)
    emails?.sort((a, b) => {
      const timestampA = new Date(a.properties?.hs_timestamp || 0).getTime();
      const timestampB = new Date(b.properties?.hs_timestamp || 0).getTime();
      return timestampB - timestampA;
    }) || [];

    const summary = `Successfully retrieved ${emails.length} email(s)`;

    $.export("$summary", summary);

    return emails;
  },
};

Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
HubSpot	`hubspot`	`app`	This component uses the HubSpot app.
Associated Object Type	`objectType`	`string`	Select a value from the drop down menu.
Object ID	`objectId`	`string`	Select a value from the drop down menu.
Additional Properties	`additionalProperties`	`string[]`	Additional properties to retrieve for the emails
Limit	`limit`	`integer`	Maximum number of emails to retrieve

Authentication#

HubSpot uses OAuth authentication. When you connect your HubSpot account, Pipedream will open a popup window where you can sign into HubSpot and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any HubSpot API.

Pipedream requests the following authorization scopes when you connect your account:

business-intelligencecrm.lists.readcrm.lists.writecrm.objects.companies.readcrm.objects.companies.writecrm.objects.contacts.readcrm.objects.contacts.writecrm.objects.deals.readcrm.objects.deals.writecrm.objects.quotes.readcrm.objects.quotes.writecrm.objects.owners.readcrm.objects.listings.writecrm.objects.listings.readcrm.schemas.companies.readcrm.schemas.companies.writecrm.schemas.contacts.readcrm.schemas.contacts.writecrm.schemas.deals.readcrm.schemas.deals.writecrm.schemas.quotes.readcrm.schemas.listings.writecrm.schemas.listings.readconversations.readcrm.importfilesformsforms-uploaded-filesintegration-syncoauthtimeline