Skip to content
Capgo

@capgo/capacitor-contacts

Access, search, and manage device contacts in your Capacitor app

The Capacitor Contacts plugin provides access to device contacts, allowing you to read, search, create, and manage contacts from the user’s address book.

Key Features

  • Read Contacts - Access device contact list
  • Search - Find contacts by name, email, or phone
  • Create/Update - Add new contacts or modify existing ones
  • Delete - Remove contacts from device
  • Permissions - Handle contact permissions properly

Installation

Terminal window
npm install @capgo/capacitor-contacts
npx cap sync

Platform Support

  • iOS: Full support with Privacy manifest compliance
  • Android: Full support
  • Web: Not supported (no browser API for contacts)

Use Cases

  • Contact Pickers - Let users select contacts
  • Social Features - Find friends using contact list
  • Communication Apps - Display and manage contacts
  • CRM Apps - Sync contacts with business systems

API Overview

The plugin provides methods to:

  • Request contact permissions
  • Get all contacts or specific contact
  • Search contacts by query
  • Create new contacts
  • Update existing contacts
  • Delete contacts

Next Steps

Get started with the Getting Started guide to integrate contacts functionality into your Capacitor app.

Resources