Reference version

SDK 51

Archive Expo Snack Discord and Forums Newsletter

Expo Contacts

GitHub

npm

A library that provides access to the phone's system contacts.

Android

iOS

expo-contacts provides access to the device's system contacts, allowing you to get contact information as well as adding, editing, or removing contacts.

On iOS, contacts have a multi-layered grouping system that you can also access through this API.

Installation

Terminal

- npx expo install expo-contacts

If you are installing this in an existing React Native app, start by installing expo in your project. Then, follow the additional instructions as mentioned by the library's README under "Installation in bare React Native projects" section.

Configuration in app.json/app.config.js

You can configure expo-contacts using its built-in config plugin if you use config plugins in your project (EAS Build or npx expo run:[android|ios]). The plugin allows you to configure various properties that cannot be set at runtime and require building a new app binary to take effect.

Example app.json with config plugin

app.json

{
  "expo": {
    "plugins": [
      [
        "expo-contacts",
        {
          "contactsPermission": "Allow $(PRODUCT_NAME) to access your contacts."
        }
      ]
    ]
  }
}

Configurable properties

Name	Default	Description
`contactsPermission`	`"Allow $(PRODUCT_NAME) to access your contacts"`	Only for: iOS A string to set the `NSContactsUsageDescription` permission message.

Are you using this library in a bare React Native app?

Learn how to configure the native projects in the installation instructions in the expo-contacts repository.

Usage

Basic Contacts Usage

import { useEffect } from 'react';
import { StyleSheet, View, Text } from 'react-native';
import * as Contacts from 'expo-contacts';

export default function App() {
  useEffect(() => {
    (async () => {
      const { status } = await Contacts.requestPermissionsAsync();
      if (status === 'granted') {
        const { data } = await Contacts.getContactsAsync({
          fields: [Contacts.Fields.Emails],
        });

        if (data.length > 0) {
          const contact = data[0];
          console.log(contact);
        }
      }
    })();
  }, []);

  return (
    <View style={styles.container}>
      <Text>Contacts Module Example</Text>
    </View>
  );
}

const styles = StyleSheet.create({
  container: {
    flex: 1,
    backgroundColor: '#fff',
    alignItems: 'center',
    justifyContent: 'center',
  },
});

API

import * as Contacts from 'expo-contacts';

Methods

`Contacts.addContactAsync(contact, containerId)`

Parameter	Type	Description
contact	`Contact`	A contact with the changes you wish to persist. The `id` parameter will not be used.
containerId (optional)	`string`	Only for: iOS The container that will parent the contact.

Creates a new contact and adds it to the system.

Note: For Android users, the Expo Go app does not have the required WRITE_CONTACTS permission to write to Contacts. You will need to create a development build and add permission in there manually to use this method.

Returns:

Promise<string>

A promise that fulfills with ID of the new system contact.

Example

const contact = {
  [Contacts.Fields.FirstName]: 'Bird',
  [Contacts.Fields.LastName]: 'Man',
  [Contacts.Fields.Company]: 'Young Money',
};
const contactId = await Contacts.addContactAsync(contact);

Only for:

iOS

`Contacts.addExistingContactToGroupAsync(contactId, groupId)`

Parameter	Type	Description
contactId	`string`	ID of the contact you want to edit.
groupId	`string`	ID for the group you want to add membership to.

Add a contact as a member to a group. A contact can be a member of multiple groups.

Returns:

Promise<any>

Example

await Contacts.addExistingContactToGroupAsync(
  '665FDBCFAE55-D614-4A15-8DC6-161A368D',
  '161A368D-D614-4A15-8DC6-665FDBCFAE55'
);

Only for:

iOS

`Contacts.addExistingGroupToContainerAsync(groupId, containerId)`

Parameter	Type	Description
groupId	`string`	The group you want to target.
containerId	`string`	The container you want to add membership to.

Add a group to a container.

Returns:

Promise<any>

Example

await Contacts.addExistingGroupToContainerAsync(
  '161A368D-D614-4A15-8DC6-665FDBCFAE55',
  '665FDBCFAE55-D614-4A15-8DC6-161A368D'
);

Only for:

iOS

`Contacts.createGroupAsync(name, containerId)`

Parameter	Type	Description
name (optional)	`string`	Name of the new group.
containerId (optional)	`string`	The container you to add membership to.

Create a group with a name, and add it to a container. If the container is undefined, the default container will be targeted.

Returns:

Promise<string>

A promise that fulfills with ID of the new group.

Example

const groupId = await Contacts.createGroupAsync('Sailor Moon');

`Contacts.getContactByIdAsync(id, fields)`

Parameter	Type	Description
id	`string`	The ID of a system contact.
fields (optional)	`FieldType[]`	If specified, the fields defined will be returned. When skipped, all fields will be returned.

Used for gathering precise data about a contact. Returns a contact matching the given id.

Returns:

Promise<Contact | undefined>

A promise that fulfills with Contact object with ID matching the input ID, or undefined if there is no match.

Example

const contact = await Contacts.getContactByIdAsync('161A368D-D614-4A15-8DC6-665FDBCFAE55');
if (contact) {
  console.log(contact);
}

`Contacts.getContactsAsync(contactQuery)`

Parameter	Type	Description
contactQuery (optional)	`ContactQuery`	Object used to query contacts. Default:`{}`

Return a list of contacts that fit a given criteria. You can get all of the contacts by passing no criteria.

Returns:

Promise<ContactResponse>

A promise that fulfills with ContactResponse object returned from the query.

Example

const { data } = await Contacts.getContactsAsync({
  fields: [Contacts.Fields.Emails],
});

if (data.length > 0) {
  const contact = data[0];
  console.log(contact);
}

Only for:

iOS

`Contacts.getContainersAsync(containerQuery)`

Parameter	Type	Description
containerQuery	`ContainerQuery`	Information used to gather containers.

Query a list of system containers.

Returns:

Promise<Container[]>

A promise that fulfills with array of containers that fit the query.

Example

const allContainers = await Contacts.getContainersAsync({
  contactId: '665FDBCFAE55-D614-4A15-8DC6-161A368D',
});

Only for:

iOS

`Contacts.getDefaultContainerIdAsync()`

Get the default container's ID.

Returns:

Promise<string>

A promise that fulfills with default container ID.

Example

const containerId = await Contacts.getDefaultContainerIdAsync();

Only for:

iOS

`Contacts.getGroupsAsync(groupQuery)`

Parameter	Type	Description
groupQuery	`GroupQuery`	Information regarding which groups you want to get.

Query and return a list of system groups.

Returns:

Promise<Group[]>

A promise that fulfills with array of groups that fit the query.

Example

const groups = await Contacts.getGroupsAsync({ groupName: 'sailor moon' });
const allGroups = await Contacts.getGroupsAsync({});

`Contacts.getPagedContactsAsync(contactQuery)`

Parameter	Type
contactQuery (optional)	`ContactQuery`

Returns:

Promise<ContactResponse>

`Contacts.getPermissionsAsync()`

Checks user's permissions for accessing contacts data.

Returns:

Promise<PermissionResponse>

A promise that resolves to a PermissionResponse object.

`Contacts.isAvailableAsync()`

Returns whether the Contacts API is enabled on the current device. This method does not check the app permissions.

Returns:

Promise<boolean>

A promise that fulfills with a boolean, indicating whether the Contacts API is available on the current device. It always resolves to false on web.

`Contacts.presentContactPickerAsync()`

Presents a native contact picker to select a single contact from the system. On Android, the READ_CONTACTS permission is required. You can obtain this permission by calling the Contacts.requestPermissionsAsync() method. On iOS, no permissions are required to use this method.

Returns:

Promise<Contact | null>

A promise that fulfills with a single Contact object if a contact is selected or null if no contact is selected (when selection is canceled).

`Contacts.presentFormAsync(contactId, contact, formOptions)`

Parameter	Type	Description
contactId (optional)	`null \| string`	The ID of a system contact.
contact (optional)	`null \| Contact`	A contact with the changes you want to persist.
formOptions (optional)	`FormOptions`	Options for the native editor. Default:`{}`

Present a native form for manipulating contacts.

Returns:

Promise<any>

Example

await Contacts.presentFormAsync('161A368D-D614-4A15-8DC6-665FDBCFAE55');

Only for:

iOS

`Contacts.removeContactAsync(contactId)`

Parameter	Type	Description
contactId	`string`	ID of the contact you want to delete.

Delete a contact from the system.

Returns:

Promise<any>

Example

await Contacts.removeContactAsync('161A368D-D614-4A15-8DC6-665FDBCFAE55');

Only for:

iOS

`Contacts.removeContactFromGroupAsync(contactId, groupId)`

Parameter	Type	Description
contactId	`string`	ID of the contact you want to remove.
groupId	`string`	ID for the group you want to remove membership of.

Remove a contact's membership from a given group. This will not delete the contact.

Returns:

Promise<any>

Example

await Contacts.removeContactFromGroupAsync(
  '665FDBCFAE55-D614-4A15-8DC6-161A368D',
  '161A368D-D614-4A15-8DC6-665FDBCFAE55'
);

Only for:

iOS

`Contacts.removeGroupAsync(groupId)`

Parameter	Type	Description
groupId	`string`	ID of the group you want to remove.

Delete a group from the device.

Returns:

Promise<any>

Example

await Contacts.removeGroupAsync('161A368D-D614-4A15-8DC6-665FDBCFAE55');

`Contacts.requestPermissionsAsync()`

Asks the user to grant permissions for accessing contacts data.

Returns:

Promise<PermissionResponse>

A promise that resolves to a PermissionResponse object.

`Contacts.shareContactAsync(contactId, message, shareOptions)`

Parameter	Type
contactId	`string`
message	`string`
shareOptions (optional)	`ShareOptions`

Returns:

Promise<any>

Only for:

iOS

`Contacts.updateContactAsync(contact)`

Parameter	Type	Description
contact	`Contact`	A contact object including the wanted changes.

Mutate the information of an existing contact. Due to an iOS bug, nonGregorianBirthday field cannot be modified.

On Android, you can use presentFormAsync to make edits to contacts.

Returns:

Promise<string>

A promise that fulfills with ID of the updated system contact if mutation was successful.

Example

const contact = {
  id: '161A368D-D614-4A15-8DC6-665FDBCFAE55',
  [Contacts.Fields.FirstName]: 'Drake',
  [Contacts.Fields.Company]: 'Young Money',
};
await Contacts.updateContactAsync(contact);

Only for:

iOS

`Contacts.updateGroupNameAsync(groupName, groupId)`

Parameter	Type	Description
groupName	`string`	New name for an existing group.
groupId	`string`	ID of the group you want to edit.

Change the name of an existing group.

Returns:

Promise<any>

Example

await Contacts.updateGroupName('Expo Friends', '161A368D-D614-4A15-8DC6-665FDBCFAE55');

`Contacts.writeContactToFileAsync(contactQuery)`

Parameter	Type	Description
contactQuery (optional)	`ContactQuery`	Used to query contact you want to write. Default:`{}`

Query a set of contacts and write them to a local URI that can be used for sharing.

Returns:

Promise<string | undefined>

A promise that fulfills with shareable local URI, or undefined if there was no match.

Example

const localUri = await Contacts.writeContactToFileAsync({
  id: '161A368D-D614-4A15-8DC6-665FDBCFAE55',
});
Share.share({ url: localUri, message: 'Call me!' });

Interfaces

`PermissionResponse`

An object obtained by permissions get and request functions.

PermissionResponse Properties

Name	Type	Description
canAskAgain	`boolean`	Indicates if user can be asked again for specific permission. If not, one should be directed to the Settings app in order to enable/disable the permission.
expires	`PermissionExpiration`	Determines time when the permission expires.
granted	`boolean`	A convenience boolean that indicates if the permission is granted.
status	`PermissionStatus`	Determines the status of the permission.

Types

`Address`

Name	Type	Description
city (optional)	`string`	City name.
country (optional)	`string`	Country name
id (optional)	`string`	Unique ID. This value will be generated by the OS.
isoCountryCode (optional)	`string`	Standard country code.
label	`string`	Localized display name.
neighborhood (optional)	`string`	Neighborhood name.
poBox (optional)	`string`	P.O. Box.
postalCode (optional)	`string`	Local post code.
region (optional)	`string`	Region or state name.
street (optional)	`string`	Street name.

`CalendarFormatType`

Literal Type: multiple types

Acceptable values are: CalendarFormats

`Contact`

A set of fields that define information about a single contact entity.

Name	Type	Description
addresses (optional)	`Address[]`	Locations.
birthday (optional)	`Date`	Birthday information in Gregorian format.
company (optional)	`string`	Organization the entity belongs to.
contactType	`ContactType`	Denoting a person or company.
dates (optional)	`Date[]`	A labeled list of other relevant user dates in Gregorian format.
department (optional)	`string`	Job department.
emails (optional)	`Email[]`	Email addresses.
firstName (optional)	`string`	Given name.
id (optional)	`string`	Immutable identifier used for querying and indexing. This value will be generated by the OS when the contact is created.
image (optional)	`Image`	Thumbnail image. On iOS it size is set to 320×320px, on Android it may vary.
imageAvailable (optional)	`boolean`	Used for efficient retrieval of images.
instantMessageAddresses (optional)	`InstantMessageAddress[]`	Instant messaging connections.
jobTitle (optional)	`string`	Job description.
lastName (optional)	`string`	Last name.
maidenName (optional)	`string`	Maiden name.
middleName (optional)	`string`	Middle name
name	`string`	Full name with proper format.
namePrefix (optional)	`string`	Dr., Mr., Mrs., and so on.
nameSuffix (optional)	`string`	Jr., Sr., an so on.
nickname (optional)	`string`	An alias to the proper name.
nonGregorianBirthday (optional)	`Date`	Only for: iOS Birthday that doesn't conform to the Gregorian calendar format, interpreted based on the calendar `format` setting.
note (optional)	`string`	Additional information. The `note` field requires your app to request additional entitlements. The Expo Go app does not contain those entitlements, so in order to test this feature you will need to request the entitlement from Apple, set the `ios.accessesContactNotes` field in app config to `true`, and create your development build.
phoneNumbers (optional)	`PhoneNumber[]`	Phone numbers.
phoneticFirstName (optional)	`string`	Pronunciation of the first name.
phoneticLastName (optional)	`string`	Pronunciation of the last name.
phoneticMiddleName (optional)	`string`	Pronunciation of the middle name.
rawImage (optional)	`Image`	Raw image without cropping, usually large.
relationships (optional)	`Relationship[]`	Names of other relevant user connections.
socialProfiles (optional)	`SocialProfile[]`	Only for: iOS Social networks.
urlAddresses (optional)	`UrlAddress[]`	Associated web URLs.

`ContactQuery`

Used to query contacts from the user's device.

Name	Type	Description
containerId (optional)	`string`	Only for: iOS Get all contacts that belong to the container matching this ID.
fields (optional)	`FieldType[]`	If specified, the defined fields will be returned. If skipped, all fields will be returned.
groupId (optional)	`string`	Only for: iOS Get all contacts that belong to the group matching this ID.
id (optional)	`string \| string[]`	Get contacts with a matching ID or array of IDs.
name (optional)	`string`	Get all contacts whose name contains the provided string (not case-sensitive).
pageOffset (optional)	`number`	The number of contacts to skip before gathering contacts.
pageSize (optional)	`number`	The max number of contacts to return. If skipped or set to `0` all contacts will be returned.
rawContacts (optional)	`boolean`	Only for: iOS Prevent unification of contacts when gathering. Default:`false`
sort (optional)	`ContactSort`	Sort method used when gathering contacts.

`ContactResponse`

The return value for queried contact operations like getContactsAsync.

Name	Type	Description
data	`Contact[]`	An array of contacts that match a particular query.
hasNextPage	`boolean`	This will be `true` if there are more contacts to retrieve beyond what is returned.
hasPreviousPage	`boolean`	This will be `true` if there are previous contacts that weren't retrieved due to `pageOffset` limit.

`ContactSort`

String union of SortTypes values.

`ContactType`

Literal Type: multiple types

Acceptable values are: ContactTypes

`Container`

Name	Type	Description
id	`string`	-
name	`string`	-
type	`ContainerType`	-

Only for:

iOS

`ContainerQuery`

Used to query native contact containers.

Name	Type	Description
contactId (optional)	`string`	Query all the containers that parent a contact.
containerId (optional)	`string \| string[]`	Query all the containers that matches ID or an array od IDs.
groupId (optional)	`string`	Query all the containers that parent a group.

`ContainerType`

Literal Type: multiple types

Acceptable values are: ContainerTypes

`Date`

Name	Type	Description
day (optional)	`number`	Day.
format (optional)	`CalendarFormatType`	Format for the input date.
id (optional)	`string`	Unique ID. This value will be generated by the OS.
label	`string`	Localized display name.
month (optional)	`number`	Month - adjusted for JavaScript `Date` which starts at `0`.
year (optional)	`number`	Year.

`Email`

Name	Type	Description
email (optional)	`string`	Email address.
id (optional)	`string`	Unique ID. This value will be generated by the OS.
isPrimary (optional)	`boolean`	Flag signifying if it is a primary email address.
label	`string`	Localized display name.

`FieldType`

Literal Type: multiple types

Acceptable values are: Fields

`FormOptions`

Denotes the functionality of a native contact form.

Name	Type	Description
allowsActions (optional)	`boolean`	Actions like share, add, create.
allowsEditing (optional)	`boolean`	Allows for contact mutation.
alternateName (optional)	`string`	Used if contact doesn't have a name defined.
cancelButtonTitle (optional)	`string`	The name of the left bar button.
displayedPropertyKeys (optional)	`FieldType[]`	The properties that will be displayed. On iOS those properties does nothing while in editing mode.
groupId (optional)	`string`	The parent group for a new contact.
isNew (optional)	`boolean`	Present the new contact controller. If set to `false` the unknown controller will be shown.
message (optional)	`string`	Controller title.
preventAnimation (optional)	`boolean`	Prevents the controller from animating in.
shouldShowLinkedContacts (optional)	`boolean`	Show or hide the similar contacts.

Only for:

iOS

`Group`

A parent to contacts. A contact can belong to multiple groups. Here are some query operations you can perform:

Child Contacts: getContactsAsync({ groupId })
Groups From Container: getGroupsAsync({ containerId })
Groups Named: getContainersAsync({ groupName })

Name	Type	Description
id (optional)	`string`	The editable name of a group.
name (optional)	`string`	Immutable id representing the group.

Only for:

iOS

`GroupQuery`

Used to query native contact groups.

Name	Type	Description
containerId (optional)	`string`	Query all groups that belong to a certain container.
groupId (optional)	`string`	Query the group with a matching ID.
groupName (optional)	`string`	Query all groups matching a name.

`Image`

Information regarding thumbnail images.

On Android you can get dimensions using Image.getSize method.

Name	Type	Description
base64 (optional)	`string`	Image as Base64 string.
height (optional)	`number`	Only for: iOS Image height
uri (optional)	`string`	A local image URI. Note: If you have a remote URI, download it first using `FileSystem.downloadAsync`.
width (optional)	`number`	Only for: iOS Image width.

`InstantMessageAddress`

Name	Type	Description
id (optional)	`string`	Unique ID. This value will be generated by the OS.
label	`string`	Localized display name.
localizedService (optional)	`string`	Localized name of app.
service (optional)	`string`	Name of instant messaging app.
username (optional)	`string`	Username in IM app.

`PermissionExpiration`

Literal Type: multiple types

Permission expiration time. Currently, all permissions are granted permanently.

Acceptable values are: 'never' | number

`PhoneNumber`

Name	Type	Description
countryCode (optional)	`string`	Country code. Example `us`
digits (optional)	`string`	Phone number without format. Example `8674305`
id (optional)	`string`	Unique ID. This value will be generated by the OS.
isPrimary (optional)	`boolean`	Flag signifying if it is a primary phone number.
label	`string`	Localized display name.
number (optional)	`string`	Phone number.

`Relationship`

Name	Type	Description
id (optional)	`string`	Unique ID. This value will be generated by the OS.
label	`string`	Localized display name.
name (optional)	`string`	Name of related contact.

Only for:

iOS

`SocialProfile`

Name	Type	Description
id (optional)	`string`	Unique ID. This value will be generated by the OS.
label	`string`	Localized display name.
localizedProfile (optional)	`string`	Localized profile name.
service (optional)	`string`	Name of social app.
url (optional)	`string`	Web URL.
userId (optional)	`string`	Username ID in social app.
username (optional)	`string`	Username in social app.