# Google Contacts Search (`google-contacts.search`)

Searches the contacts of the connected Google account by name, email or phone and returns their details.

Docs: https://primaryapi.com/docs/api-reference/google-contacts/search

- Endpoint: `POST https://api.primaryapi.com/v1/run/google-contacts.search`
- Category: Knowledge & Data · Platform: `google-contacts` · Kind: search · Status: live
- Price: 1 credit per call. Every call costs the same, including calls that were retried automatically.
- Billing unit: per successful call
- Reliability: routed to a healthy upstream and retried automatically when an attempt fails; live 30-day status: `GET https://api.primaryapi.com/v1/status/apis?sku=google-contacts.search`
- Execution: synchronous (answers 202 only if it outlives the wait window)

## Input

| Field | Type | Required | Default | Constraints | Description |
|---|---|---|---|---|---|
| `query` | string | yes |  | max 500 chars | The start of a name, email address or phone number to match, for example "ada" or "ada@". |
| `limit` | integer | no | 10 | 1–30 | Maximum number of results to return (1-30, default 10). |
| `connection` | string | no |  | max 200 chars | Which connected account to use when the workspace has several for this provider: the customId you gave it (exact), its connection id ("con_…"), its handle (login, email or @handle) or its name. Optional; prefer the customId or id, which never match two accounts. |

Unknown fields are rejected with `400 invalid_input`. The routing controls `preferLatencyUnderMs` and `maxCredits` may be sent in the same JSON body.

## Output

When `output.found` is `true`, `output.data` has this shape:

| Field | Type | Description |
|---|---|---|
| `contacts` | object[] |  |
| `contacts[].resourceName` | string | People API id, "people/…" |
| `contacts[].name` | string \| null |  |
| `contacts[].givenName` | string \| null |  |
| `contacts[].familyName` | string \| null |  |
| `contacts[].emails` | object[] |  |
| `contacts[].emails[].value` | string |  |
| `contacts[].emails[].type` | string \| null |  |
| `contacts[].phones` | object[] |  |
| `contacts[].phones[].value` | string |  |
| `contacts[].phones[].e164` | string \| null | E.164 form, when Google could derive it |
| `contacts[].phones[].type` | string \| null |  |
| `contacts[].organizations` | object[] |  |
| `contacts[].organizations[].name` | string \| null |  |
| `contacts[].organizations[].title` | string \| null |  |
| `contacts[].photoUrl` | string \| null |  |
| `nextCursor` | string \| null |  |

When the thing you asked about does not exist (or a search matches nothing) the call still succeeds: `output.found` is `false`, `output.data` is `null` and `output.reason` says why (`not_found`, `private`, `no_results`, …). Misses are free unless the notes below say misses are billed.

## Example request

```bash
curl -sS -X POST "https://api.primaryapi.com/v1/run/google-contacts.search" \
  -H "Authorization: Bearer $PRIMARYAPI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"query":"ada","limit":5}'
```

## Example response

_Values are placeholders that follow the output schema; `credits` is what this call would cost at the usual price._

```json
{
  "output": {
    "found": true,
    "data": {
      "contacts": [
        {
          "resourceName": "people/c1234567890123456789",
          "name": "Ada Example",
          "givenName": "Ada",
          "familyName": "Example",
          "emails": [
            {
              "value": "ada@example.com",
              "type": "work"
            }
          ],
          "phones": [
            {
              "value": "+44 20 7946 0000",
              "e164": "+442079460000",
              "type": "mobile"
            }
          ],
          "organizations": [
            {
              "name": "Example Ltd",
              "title": "Engineer"
            }
          ],
          "photoUrl": "https://lh3.googleusercontent.com/contacts/AExamplePhoto"
        }
      ],
      "nextCursor": null
    }
  },
  "provider": "PrimaryAPI",
  "credits": 1,
  "items": 1,
  "requestId": "req_01JBXK6Y2N9V8T4R3Q2P1M0A7Z",
  "nextCursor": null
}
```

## Pricing and reliability

- Usual price: 1 credit per call
- Price ceiling: the usual price, even when a call is retried. A quote’s `maxCredits` is the most a given call can cost; the `maxCredits` routing control caps it per call
- Live 30-day status, success rate, uptime and latency: `GET https://api.primaryapi.com/v1/status/apis?sku=google-contacts.search`

## Errors to handle

`invalid_input`, `unauthorized`, `insufficient_balance`, `key_limit_reached`, `trial_cap_reached`, `forbidden`, `not_found`, `idempotency_conflict`, `rate_limited`, `all_sources_failed`, `service_unavailable`, `timeout`. See https://primaryapi.com/docs/errors.

## Notes

Runs as your connected Google account (read-only Contacts access). Matches the start of names, emails and phone numbers; up to 30 contacts per call.

