v4

latestOpenAPI 3.1.02026-08-03427198448.4 KB
google-api

Get Google Contacts

Get user's Google contacts.

Always pulls from People API "My Contacts" (people.connections). When include_other=True (default), also pulls "Other Contacts" — the bucket Gmail auto-populates from any email recipient (To/CC/BCC) the user has sent to. Per Google's Contacts Help docs, Other Contacts captures the full history of email recipients, so it covers what a Gmail-sent-folder scan would otherwise return — without the cost of thousands of message reads.

google_account_id (optional) selects which of the user's connected Google accounts to pull from; default is the primary, unchanged.

Returns a single deduped list. The two buckets are merged on lowercase email; My Contacts wins on collision (richer profile data).

get/api/google/contacts

Query parameters

user_idstring
org_idstring
max_resultsinteger
fetch_allboolean
include_otherboolean
google_account_idstring

Response

Successful Response

{"stackTrail":"paths:/api/google/contacts:get:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}