Search Contacts with Microsoft Outlook Calendar API

Pipedream makes it easy to connect APIs for Microsoft Outlook Calendar and 3,000+ other apps remarkably fast.

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

Search Contacts with the Microsoft Outlook Calendar 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 Search Contacts with the Microsoft Outlook Calendar API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the Search Contacts action
1. Connect your Microsoft Outlook Calendar account
2. Optional- Configure Search Query
3. Optional- Configure Filter
4. Optional- Configure Expand
5. Optional- Configure Select
6. Optional- Configure Max Results
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

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.

Search Contacts on Microsoft Outlook Calendar

Description:Search for contacts by name from your saved contacts list and retrieve their email addresses. [See the documentation](https://learn.microsoft.com/en-us/graph/api/user-list-contacts)

Version:0.0.1

Key:microsoft_outlook_calendar-search-contacts

View on GitHub

Code#

import microsoftOutlook from "../../microsoft_outlook_calendar.app.mjs";

export default {
  key: "microsoft_outlook_calendar-search-contacts",
  name: "Search Contacts",
  description: "Search for contacts by name from your saved contacts list and retrieve their email addresses. [See the documentation](https://learn.microsoft.com/en-us/graph/api/user-list-contacts)",
  version: "0.0.1",
  type: "action",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: true,
  },
  props: {
    microsoftOutlook,
    search: {
      type: "string",
      label: "Search Query",
      description: "Search for contacts by name (e.g., 'John Doe'). Searches display name, given name, and surname.",
      optional: true,
    },
    filter: {
      type: "string",
      label: "Filter",
      description: "Filter contacts by email address using [OData syntax](https://learn.microsoft.com/en-us/azure/search/search-query-odata-syntax-reference). For example, `emailAddresses/any(a:a/address eq 'john@example.com')`. Note: $filter only works with the `address` sub-property of `emailAddresses`. [See the documentation](https://learn.microsoft.com/en-us/graph/api/user-list-contacts)",
      optional: true,
    },
    expand: {
      type: "string",
      label: "Expand",
      description: "Comma-separated list of relationships to expand and include in the response. See the [relationships table of the contact](https://learn.microsoft.com/en-us/graph/api/resources/contact?view=graph-rest-1.0#relationships) object for supported names.",
      optional: true,
    },
    select: {
      type: "string",
      label: "Select",
      description: "Comma-separated list of [properties](https://learn.microsoft.com/en-us/graph/api/resources/contact?view=graph-rest-1.0#properties) to include in the response.",
      optional: true,
    },
    maxResults: {
      type: "integer",
      label: "Max Results",
      description: "The maximum number of contacts to return",
      optional: true,
    },
  },
  async run({ $ }) {
    const {
      search,
      filter,
      expand,
      select,
      maxResults,
    } = this;

    const response = await this.microsoftOutlook.listContacts({
      $,
      params: {
        "$top": maxResults,
        "$filter": filter,
        "$search": search,
        "$expand": expand,
        "$select": select,
      },
    });

    $.export("$summary", `Successfully retrieved \`${response.value.length}\` contact(s)`);

    return response;
  },
};

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
Microsoft Outlook Calendar	`microsoftOutlook`	`app`	This component uses the Microsoft Outlook Calendar app.
Search Query	`search`	`string`	Search for contacts by name (e.g., 'John Doe'). Searches display name, given name, and surname.
Filter	`filter`	`string`	Filter contacts by email address using OData syntax. For example, `emailAddresses/any(a:a/address eq 'john@example.com')`. Note: $filter only works with the `address` sub-property of `emailAddresses`. See the documentation
Expand	`expand`	`string`	Comma-separated list of relationships to expand and include in the response. See the relationships table of the contact object for supported names.
Select	`select`	`string`	Comma-separated list of properties to include in the response.
Max Results	`maxResults`	`integer`	The maximum number of contacts to return

Authentication#

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

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

User.Reademailoffline_accessopenidprofileCalendars.ReadWritePeople.Read

About Microsoft Outlook Calendar#

The calendar and scheduling component of Outlook that is fully integrated with email, contacts, and other features

More Ways to Use Microsoft Outlook Calendar#

Triggers#

New Calendar Event (Instant) from the Microsoft Outlook Calendar API

Emit new event when a new Calendar event is created

Try it

New Calendar Event Update (Instant) from the Microsoft Outlook Calendar API

Emit new event when a Calendar event is updated

Try it

New Upcoming Calendar Event from the Microsoft Outlook Calendar API

Emit new event when a Calendar event is upcoming, this source is using reminderMinutesBeforeStart property of the event to determine the time it should emit.

Try it

New Upcoming Calendar Event (Polling) from the Microsoft Outlook Calendar API

Emit new event based on a time interval before an upcoming calendar event. See the documentation

Try it

Actions#

Create Calendar Event with the Microsoft Outlook Calendar API

Create an event in the user's default calendar. See the documentation

Try it

Delete Calendar Event with the Microsoft Outlook Calendar API

Delete an event in the user's default calendar. See the documentation

Try it

Delete Recurring Event Instance with the Microsoft Outlook Calendar API

Delete an individual instance of a recurring event in the user's default calendar. See the documentation

Try it

Get Free/Busy Schedule with the Microsoft Outlook Calendar API

Get the free/busy availability information for a collection of users, distributions lists, or resources (rooms or equipment) for a specified time period. See the documentation

Try it

List Events with the Microsoft Outlook Calendar API

Get a list of event objects in the user's mailbox. See the documentation

Try it