# Text search (Google Places)

Operation ID: `connectors.googlePlacesText`

Text search via Google Places. Returns a list of GooglePlace records.

## Public method

`textSearch`

Signature: `connectors.googlePlaces.createClient(config).textSearch(body)`

Return type: `Promise<GooglePlacesSearchResponse>`

## Authentication

Classification: **AUTHENTICATED**

Schemes: `bearerAuth`

## Prerequisites

None documented.

## HTTP

`POST /connectors/google-places/text-search`

## Path parameters

None.

## Query parameters

None.

## Body parameters

| Name | Type | Required | Format | Allowed values | Default | Nullable | Description |
|---|---|---:|---|---|---|---:|---|
| `body` | [`GooglePlacesTextSearchRequest`](../models/GooglePlacesTextSearchRequest.md) | Yes |  |  |  | No |  |

Request model: [`GooglePlacesTextSearchRequest`](../models/GooglePlacesTextSearchRequest.md)

## Request example

```json
{
  "api_key": "example-api-key",
  "location": "example-location",
  "max_results": 20,
  "mode": "sandbox",
  "query": "example-query",
  "radius": 1000
}
```

## Success responses

| Status | Shape | Content type | Description |
|---|---|---|---|
| `200` | [`GooglePlacesTextSearchResponse`](../models/GooglePlacesTextSearchResponse.md) | application/json | Successful response |

## Success response examples

### 200

```json
[
  {
    "display_name": "Example Name",
    "formatted_address": "example-formatted-address",
    "id": "12345",
    "international_phone_number": "+15555550123",
    "price_level": "example-price-level",
    "rating": 1,
    "types": [
      "example-types"
    ],
    "website_uri": "example-website-uri"
  }
]
```

## Common errors

| Status | Shape | Content type | Description |
|---|---|---|---|
| `400` | [`StandardErrorResponse`](../models/StandardErrorResponse.md) | application/json | Connector validation rejected the payload, or a required field was missing or of the wrong type. |
| `401` | [`StandardErrorResponse`](../models/StandardErrorResponse.md) | application/json | The HealthCloud bearer token is missing or invalid, or the vendor rejected the supplied connector credentials. |
| `500` | [`StandardErrorResponse`](../models/StandardErrorResponse.md) | application/json | The connector failed unexpectedly. |
| `502` | [`StandardErrorResponse`](../models/StandardErrorResponse.md) | application/json | The vendor returned an application or transport-level failure. |
| `504` | [`StandardErrorResponse`](../models/StandardErrorResponse.md) | application/json | The vendor did not respond within the connector timeout. |

## Error examples

### 400 — Invalid request

```json
{
  "error": "Invalid request"
}
```

### 401 — Authorization required

```json
{
  "error": "Authorization required"
}
```

### 500 — Internal error

```json
{
  "error": "Internal error"
}
```

### 502 — Upstream vendor error

```json
{
  "error": "Upstream vendor error"
}
```

### 504 — Upstream timeout

```json
{
  "error": "Upstream timeout"
}
```

## NodeJS / TypeScript implementation

```ts
import { HCSDK } from "@healthcloudai/hc-sdk";
import type { GooglePlacesTextSearchRequest } from "@healthcloudai/hc-sdk";
```

```ts
const body = {
  "api_key": "example-api-key",
  "location": "example-location",
  "max_results": 20,
  "mode": "sandbox",
  "query": "example-query",
  "radius": 1000
};

const result = await connectors.googlePlaces.createClient(config).textSearch(body);
```

## cURL

```bash
curl -X POST \
  -H 'Authorization: Bearer <ACCESS_TOKEN>' \
  -H 'Content-Type: application/json' \
  -d '{"api_key":"example-api-key","location":"example-location","max_results":20,"mode":"sandbox","query":"example-query","radius":1000}' \
  'https://dev-api-connectors.health.cloud/connectors/google-places/text-search'
```

## Notes

None.

## Prepared Test Console scenario

No canonical scenario is currently associated.

## Real response

No approved real integration response is currently published. Unapproved candidates are never rendered as examples.
