Search Contacts

Search the contact folder collection.

Options

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 will be 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 will be performed in Contacts folder in Outlook.

  • Folder ID: search will be performed in a folder with a given Id in Outlook.

Search is performed in the Contacts folder only.

Dropdown TRUE
Search Inside Child Folders Search is performed in two levels of child folders of a selected folder. Choose whether to search inside children folders.
  • Yes

  • No

Dropdown TRUE
Tip

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

Caution

An input value cannot contain a # 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 this is not true in all cases.

This property cannot contain accent characters. Only the following characters are allowed A - Z, a - z, 0 - 9, ' . - _ ! # ^ ~

String TRUE
Search      
Email User’s email. It can be observed in Address property of Email Address object or Email field of a contact in Outlook.

A search is performed with exact match by email address.

String FALSE
Folder ID Contacts folder’s Id. The folder which stores contacts in Outlook. String FALSE
Search Criteria      
Record Limit

Specify the number of records to stream.

  • When the Limit field is set to 0, no records are returned.

  • When the Limit field is set to greater than 0, records greater than 0 and up the maximum number of records specified are returned.

  • When the Limit field is empty or not selected, all records are streamed.

  • Default value is 10 million.

  • Valid range is 0 to 10 million.

Appears when Stream Matching Records is selected from the Result Set option.

String 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.

String FALSE

Output

Field Definition Type
Result  
Given Name Contact's given name. String
Assistant Name Name of the contact's assistant. String
Birthday Contact's birthday. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. Date and Time
Business Address Contact's business address. String
Street Street of the business address. String
City City of the business address. String
State State of the business address. String
Country or Region Country or region in which the user is located. For example, US or UK. String
Postal Code Postal code of the business address. String
Business Home Page Business home page of the contact. String
Business Phones Contact's business phone numbers. String
Categories Categories associated with the contact. String
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 Strings
Children Names of the contact's children. String
Company Name Name of the contact's company. String
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 and Time
Department Department of the contact. String
Display Name Display name of the contact. String
Email Addresses Email addresses of the contact. List of Objects
Street Street of the business address. String
City City of the business address. String
State State of the business address. String
Country or Region Country or region in which the user is located. For example, US or UK. String
Postal Code Postal code of the business address. String
File As Name the contact is filed under. String
Generation Contact's generation. String
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. String
Job Title Contact’s job title. String
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 and Time
Manager Name of the contact's manager. String
Middle Name Contact's middle name. String
Mobile Phone Contact's mobile phone number. String
Nickname Contact's nickname. String
Office Location Location of the contact's office. String
Other Address Other addresses for the contact. Object
Street Street of the business address. String
City City of the business address. String
State State of the business address. String
Country or Region Country or region in which the user is located. For example, US or UK. String
Postal Code Postal code of the business address. String
Parent Folder ID ID of the folder's parent folder. String
Personal Notes User's notes about the contact. String
Profession Contact's profession. String
Spouse Name Name of the contact's spouse/partner. String
Surname Contact's surname. String
Title Contact's title. String
Yomi Company Name Phonetic Japanese company name of the contact. String
Yomi Given Name Phonetic Japanese given name (first name) of the contact. String
Yomi Surname Phonetic Japanese surname (last name) of the contact. String

Related topics

Office 365 Admin connector

About the elements of Okta Workflows

Office 365 Admin Management API overview