ScPL

Find Contacts / FindContacts (internally is.workflow.actions.filter.contacts)

This action is not yet complete. Some arguments may be missing.

This action requires that Shortcuts has permission to use WFContactAccessResource.

usage

FindContacts filter=:filter{...} sortby=("Email Address" | "Phonetic First Name" | "Prefix" | "URL" | "Nickname" | "Last Name" | "Phone Number" | "Has Photo" | "File Size" | "Creation Date" | "Last Modified Date" | "Middle Name" | "Company" | "Department" | "Name" | "Contact Photo" | "First Name" | "Phonetic Last Name" | "File Extension" | "Street Address" | "Suffix" | "Job Title" | "Notes" | "Birthday" | "Group" | "Phonetic Middle Name" | "Random") order=("Oldest First" | "Newest First" | "Latest First" | "Smallest First" | "Biggest First" | "Ascending" | "Descending" | "Shortest First" | "Longest First" | "A to Z" | "Z to A") limit=(true | false | variable) getItems=number

arguments

filter: Filter (Docs)

Accepts a :filter{} of filters. This filter supports:

• emailaddress (Not yet supported. Submit an Issue)
• phoneticfirstname (Not yet supported. Submit an Issue)
• prefix (Not yet supported. Submit an Issue)
• url (Not yet supported. Submit an Issue)
• nickname (Not yet supported. Submit an Issue)
• lastname (Not yet supported. Submit an Issue)
• phonenumber (Not yet supported. Submit an Issue)
• hasphoto (Not yet supported. Submit an Issue)
• filesize (Not yet supported. Submit an Issue)
• creationdate (Not yet supported. Submit an Issue)
• lastmodifieddate (Not yet supported. Submit an Issue)
• middlename (Not yet supported. Submit an Issue)
• company (Not yet supported. Submit an Issue)
• department (Not yet supported. Submit an Issue)
• name (Supported for is, isnot, contains, doesnotcontain, beginswith, endswith)
• contactphoto (Not yet supported. Submit an Issue)
• firstname (Not yet supported. Submit an Issue)
• phoneticlastname (Not yet supported. Submit an Issue)
• fileextension (Not yet supported. Submit an Issue)
• streetaddress (Not yet supported. Submit an Issue)
• suffix (Not yet supported. Submit an Issue)
• jobtitle (Not yet supported. Submit an Issue)
• notes (Not yet supported. Submit an Issue)
• birthday (Not yet supported. Submit an Issue)
• group (Not yet supported. Submit an Issue)
• phoneticmiddlename (Not yet supported. Submit an Issue).

Example: :filter{name is testname}

sortby: Enumeration (Docs)

Allows Variables: true

Accepts a string or variable containing one of the options:

• Email Address
• Phonetic First Name
• Prefix
• URL
• Nickname
• Last Name
• Phone Number
• Has Photo
• File Size
• Creation Date
• Last Modified Date
• Middle Name
• Company
• Department
• Name
• Contact Photo
• First Name
• Phonetic Last Name
• File Extension
• Street Address
• Suffix
• Job Title
• Notes
• Birthday
• Group
• Phonetic Middle Name
• Random

order: Enumeration (Docs)

Allows Variables: true

Only enabled if: argument WFContentItemSortProperty != Random

Accepts a string or variable containing one of the options:

• Oldest First
• Newest First
• Latest First
• Smallest First
• Biggest First
• Ascending
• Descending
• Shortest First
• Longest First
• A to Z
• Z to A

limit: Switch (Docs)

Allows Variables: true

Accepts a boolean or a variable.

getItems: Stepper Number (Docs)

Allows Variables: true

Only enabled if: argument WFSwitchParameter == true

	Accepts a number 
	or variable
	with a number.

source json (for developers)

{
	"ActionClass": "WFContentItemFilterAction",
	"AppIdentifier": "com.apple.MobileAddressBook",
	"Category": "Contacts",
	"CreationDate": "2015-01-22T08:00:00.000Z",
	"LastModifiedDate": "2015-12-14T08:00:00.000Z",
	"Name": "Find Contacts",
	"RequiredResources": [
		"WFContactAccessResource"
	],
	"Subcategory": "Contacts",
	"SuggestedAsInitialAction": false,
	"WFContentItemClass": "WFContactContentItem",
	"Parameters": [
		{
			"Class": "WFFilterParameter",
			"Key": "WFContentItemFilter",
			"Label": "Filter",
			"ContentItemClass": "WFContactContentItem"
		},
		{
			"Class": "WFEnumerationParameter",
			"Key": "WFContentItemSortProperty",
			"Label": "Sort by",
			"Items": [
				"Email Address",
				"Phonetic First Name",
				"Prefix",
				"URL",
				"Nickname",
				"Last Name",
				"Phone Number",
				"Has Photo",
				"File Size",
				"Creation Date",
				"Last Modified Date",
				"Middle Name",
				"Company",
				"Department",
				"Name",
				"Contact Photo",
				"First Name",
				"Phonetic Last Name",
				"File Extension",
				"Street Address",
				"Suffix",
				"Job Title",
				"Notes",
				"Birthday",
				"Group",
				"Phonetic Middle Name",
				"Random"
			]
		},
		{
			"Class": "WFEnumerationParameter",
			"Key": "WFContentItemSortOrder",
			"Label": "Order",
			"Items": [
				"Oldest First",
				"Newest First",
				"Latest First",
				"Smallest First",
				"Biggest First",
				"Ascending",
				"Descending",
				"Shortest First",
				"Longest First",
				"A to Z",
				"Z to A"
			],
			"RequiredResources": [
				{
					"WFParameterKey": "WFContentItemSortProperty",
					"WFParameterValues": [
						"Random"
					],
					"WFResourceClass": "WFParameterRelationResource",
					"WFParameterRelation": "!="
				}
			]
		},
		{
			"Class": "WFSwitchParameter",
			"Key": "WFContentItemLimitEnabled",
			"Label": "Limit"
		},
		{
			"Class": "WFStepperParameter",
			"Key": "WFContentItemLimitNumber",
			"Label": "Get Items",
			"RequiredResources": [
				{
					"WFParameterKey": "WFSwitchParameter",
					"WFParameterValues": [
						true
					],
					"WFResourceClass": "WFParameterRelationResource"
				}
			]
		}
	]
}