# Google Contacts (/integrations/google_contacts)



{/* MANUAL-CONTENT-START:intro */}

[Google Contacts](https://contacts.google.com/) stores contact records for a Google account. Search or list contacts to obtain their resource names, then use those names to read, update, or delete records. Create contacts with the name, email, phone, and other fields needed by your workflow.

{/* MANUAL-CONTENT-END */}

## OAuth scopes [#oauth-scopes]

Sim requests these scopes when someone connects a Google Contacts account. For a self-hosted deployment, register your own app with the provider using the settings below. See [Integrations and OAuth](/platform/self-hosting/integrations-oauth) for setup.

| Setting | Value |
| - | - |
| Redirect URI | `<NEXT_PUBLIC_APP_URL>/api/auth/oauth2/callback/google-contacts` |
| Environment variables | `GOOGLE_CLIENT_ID`, `GOOGLE_CLIENT_SECRET` |

| Scope | Description |
| - | - |
| `https://www.googleapis.com/auth/userinfo.email` | View email address |
| `https://www.googleapis.com/auth/userinfo.profile` | View basic profile info |
| `https://www.googleapis.com/auth/contacts` | View and manage Google Contacts |

## Use the block [#usage-instructions]

Create, read, update, delete, list, and search contacts.

## Actions [#actions]

### Google Contacts Create [#google-contacts-create]

Create a new contact in Google Contacts

#### Input [#input]

| Parameter | Type | Required | Description |
| - | - | - | - |
| `givenName` | string | Yes | First name of the contact |
| `familyName` | string | No | Last name of the contact |
| `email` | string | No | Email address of the contact |
| `emailType` | string | No | Email type: home, work, or other |
| `phone` | string | No | Phone number of the contact |
| `phoneType` | string | No | Phone type: mobile, home, work, or other |
| `organization` | string | No | Organization/company name |
| `jobTitle` | string | No | Job title at the organization |
| `notes` | string | No | Notes or biography for the contact |

#### Output [#output]

| Parameter | Type | Description |
| - | - | - |
| `content` | string | Contact creation confirmation message |
| `metadata` | json | Created contact metadata including resource name and details |

### Google Contacts Get [#google-contacts-get]

Get a specific contact from Google Contacts

#### Input [#input-1]

| Parameter | Type | Required | Description |
| - | - | - | - |
| `resourceName` | string | Yes | Resource name of the contact (e.g., people/c1234567890) |

#### Output [#output-1]

| Parameter | Type | Description |
| - | - | - |
| `content` | string | Contact retrieval confirmation message |
| `metadata` | json | Contact details including name, email, phone, and organization |

### Google Contacts List [#google-contacts-list]

List contacts from Google Contacts

#### Input [#input-2]

| Parameter | Type | Required | Description |
| - | - | - | - |
| `pageSize` | number | No | Number of contacts to return (1-1000, default 100) |
| `pageToken` | string | No | Page token from a previous list request for pagination |
| `sortOrder` | string | No | Sort order for contacts |

#### Output [#output-2]

| Parameter | Type | Description |
| - | - | - |
| `content` | string | Summary of found contacts count |
| `metadata` | json | List of contacts with pagination tokens |

### Google Contacts Search [#google-contacts-search]

Search contacts in Google Contacts by name, email, phone, or organization

#### Input [#input-3]

| Parameter | Type | Required | Description |
| - | - | - | - |
| `query` | string | Yes | Search query to match against contact names, emails, phones, and organizations |
| `pageSize` | number | No | Number of results to return (default 10, max 30) |

#### Output [#output-3]

| Parameter | Type | Description |
| - | - | - |
| `content` | string | Summary of search results count |
| `metadata` | json | Search results with matching contacts |

### Google Contacts Update [#google-contacts-update]

Update an existing contact in Google Contacts

#### Input [#input-4]

| Parameter | Type | Required | Description |
| - | - | - | - |
| `resourceName` | string | Yes | Resource name of the contact (e.g., people/c1234567890) |
| `etag` | string | Yes | ETag from a previous get request (required for concurrency control) |
| `givenName` | string | No | Updated first name |
| `familyName` | string | No | Updated last name |
| `email` | string | No | Updated email address |
| `emailType` | string | No | Email type: home, work, or other |
| `phone` | string | No | Updated phone number |
| `phoneType` | string | No | Phone type: mobile, home, work, or other |
| `organization` | string | No | Updated organization/company name |
| `jobTitle` | string | No | Updated job title |
| `notes` | string | No | Updated notes or biography |

#### Output [#output-4]

| Parameter | Type | Description |
| - | - | - |
| `content` | string | Contact update confirmation message |
| `metadata` | json | Updated contact metadata |

### Google Contacts Delete [#google-contacts-delete]

Delete a contact from Google Contacts

#### Input [#input-5]

| Parameter | Type | Required | Description |
| - | - | - | - |
| `resourceName` | string | Yes | Resource name of the contact to delete (e.g., people/c1234567890) |

#### Output [#output-5]

| Parameter | Type | Description |
| - | - | - |
| `content` | string | Contact deletion confirmation message |
| `metadata` | json | Deletion details including resource name |