Get all contacts

Gets all contacts on the current device.

Gets all contacts on the current device.

Once the contacts have been fetched, the first output is triggered.

If there is an error, the second output is triggered.

If the user hasn't given permission to access contacts, they will be requested to do so automatically.

Input arguments

Label

Key

Type

Required?

Default

Description

Exclude photos

excludePhotos

Boolean

No

iOS-only. Exclude creation of photo thumbnail URLs, which can have a performance overhead.

Output arguments

Number of outputs: 2

Label

Key

Type

Description

Contacts

contacts

Array

All contacts on the current device.

Events

No events.

Errors

Label

Code

Description

Unknown error

unknown

Thrown if an unknown error occurred while getting the contacts.