Search Contacts

Search for contacts in the Outlook folder collection.

Options

Field Definition Type Required

Field	Definition	Type	Required
Result Set	Choose one of the following options to display your search results: `First Matching Record`: returns a single user record `First 200 Matching Records`: returns the first 200 records that match the search criteria `Stream Matching Records`: pass all matching user records from your parent flow to a helper flow. A Streaming input section is added to the card from which you can select a helper flow for streaming and adding custom extensible fields.	Dropdown	TRUE
Search By	Choose the search operator when searching for contacts. Contacts Folder: search is performed in the Outlook Contacts folder. Folder ID: search is performed in the Outlook folder with the given ID. By default, search is performed only in the Contacts folder.	Dropdown	TRUE
Search Inside Child Folders	Search is performed inside two levels of child folders for the selected folder. Choose whether to search inside children folders. Yes No	Dropdown	TRUE

Result Set

Choose one of the following options to display your search results:

First Matching Record: returns a single user record
First 200 Matching Records: returns the first 200 records that match the search criteria
Stream Matching Records: pass all matching user records from your parent flow to a helper flow. A Streaming input section is added to the card from which you can select a helper flow for streaming and adding custom extensible fields.

Dropdown

TRUE

Search By

Choose the search operator when searching for contacts.

Contacts Folder: search is performed in the Outlook Contacts folder.
Folder ID: search is performed in the Outlook folder with the given ID.

By default, search is performed only in the Contacts folder.

Dropdown

TRUE

Search Inside Child Folders

Search is performed inside two levels of child folders for the selected folder. Choose whether to search inside children folders.

Dropdown

TRUE

To learn how to use the Stream Matching Records option and set up a helper flow to return a large number of records, see Stream matching records with a helper flow.

An input value can't contain the # hash character.

Input

Field	Definition	Type	Required
User
ID or Username	User ID is the unique identifier for the user. Should be treated as an opaque identifier. Username of the Office 365 user. This is the user's User Principal Name (UPN). A UPN is formed by taking the username and domain and combining them with the `@` separator. For example, `john.doe@somedomain.com`. This could be the user's email address, but not always. This property can't contain accent characters. Only the following characters are allowed A-Z, a-z, 0-9, '.-_!#^~.	Text	TRUE
Search
Email	User's email. Found either in the Address property of an Email Address object, or the Email field of a contact in Outlook. A search is performed with an exact match of email address.	Text	FALSE
Folder ID	Contacts folder's ID. The folder that stores contacts in Outlook.	Text	FALSE
Search Criteria
Record Limit	Specify the number of records to stream. When the Limit field is set to 0, the stream returns no records. When the Limit field is set to greater than 0, the stream returns up to the maximum number specified. When the Limit field is empty, null, or not selected, the stream returns all records. The default value is 10000000 (10 million). The valid range is 0 to 10000000. This field appears when you select Stream Matching Records from the Result Set option.	Text	FALSE
Streaming
Flow	Click Choose Flow to browse and select a helper flow where the search results will be streamed, then click Choose to confirm. Optionally, click the empty field under Click or drop here to create and add custom extensible fields that pass data to the helper flow. These fields are added as key/value pairs under the State output object in the helper flow.	Text	FALSE

Output

Field	Definition	Type
Result
Given Name	Contact's given name.	Text
Assistant Name	Name of the contact's assistant.	Text
Birthday	Contact's birthday. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time.	Date & Time
Business Address	Contact's business address.	Text
Street	Street of the business address.	Text
City	City of the business address.	Text
State	State of the business address.	Text
Country or Region	Country or region in which the user is located. For example, US or UK.	Text
Postal Code	Postal code of the business address.	Text
Business Home Page	Business home page of the contact.	Text
Business Phones	Contact's business phone numbers.	Text
Categories	Categories associated with the contact.	Text
Change Key	Identifies the version of the contact. Every time the contact is changed, Change Key changes as well. This allows Exchange to apply changes to the correct version of the object.	List of Text
Children	Names of the contact's children.	Text
Company Name	Name of the contact's company.	Text
Created Date Time	Time the contact was created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time.	Date & Time
Department	Department of the contact.	Text
Display Name	Display name of the contact.	Text
Email Addresses	Email addresses of the contact.	List of Objects
Street	Street of the business address.	Text
City	City of the business address.	Text
State	State of the business address.	Text
Country or Region	Country or region in which the user is located. For example, US or UK.	Text
Postal Code	Postal code of the business address.	Text
File As	Name the contact is filed under.	Text
Generation	Contact's generation.	Text
Home Address	Contact's home address.	Object
Home Phones	Contact's home phone numbers.	List of Text
IM Addresses	Contact's instant messaging (IM) addresses.	List of Text
Initials	Contact's initials.	Text
Job Title	Contact's job title.	Text
Last Modified Date Time	The time the contact was modified. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time.	Date & Time
Manager	Name of the contact's manager.	Text
Middle Name	Contact's middle name.	Text
Mobile Phone	Contact's mobile phone number.	Text
Nickname	Contact's nickname.	Text
Office Location	Location of the contact's office.	Text
Other Address	Other addresses for the contact.	Object
Street	Street of the business address.	Text
City	City of the business address.	Text
State	State of the business address.	Text
Country or Region	Country or region in which the user is located. For example, US or UK.	Text
Postal Code	Postal code of the business address.	Text
Parent Folder ID	ID of the folder's parent folder.	Text
Personal Notes	User's notes about the contact.	Text
Profession	Contact's profession.	Text
Spouse Name	Name of the contact's spouse or partner.	Text
Surname	Contact's surname.	Text
Title	Contact's title.	Text
Yomi Company Name	Phonetic Japanese company name of the contact.	Text
Yomi Given Name	Phonetic Japanese given name (first name) of the contact.	Text
Yomi Surname	Phonetic Japanese surname (family name) of the contact.	Text

Search Contacts

Options

Input

Output

Related topics