# List goals with optional filtering

Operation ID: `connectors.healthieGetGoals`

List goals with optional filtering. ``status_filter``: "complete" or "not_complete". ``frequency_filter``: "daily", "weekly", "one_time".

## Public method

`getGoals`

Signature: `connectors.healthie.createClient(config).getGoals(body)`

Return type: `Promise<HealthieGoalResponse>`

## Authentication

Classification: **AUTHENTICATED**

Schemes: `bearerAuth`

## Prerequisites

None documented.

## HTTP

`POST /connectors/healthie/get-goals`

## Path parameters

None.

## Query parameters

None.

## Body parameters

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

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

## Request example

```json
{
  "api_url": "https://example.com/resource",
  "keywords": "example-api-key",
  "mode": "sandbox",
  "open_loop_url": "https://example.com/resource",
  "secret_key": "example-api-key",
  "shard_id": "12345",
  "user_id": "12345"
}
```

## Success responses

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

## Success response examples

### 200

```json
[
  {
    "description": "example-description",
    "due_date": "example-due-date",
    "id": "12345",
    "is_completed_for_date": true,
    "name": "Example Name",
    "repeat": "example-repeat",
    "start_on": "example-start-on"
  }
]
```

## 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 { HealthieGetGoalsRequest } from "@healthcloudai/hc-sdk";
```

```ts
const body = {
  "api_url": "https://example.com/resource",
  "keywords": "example-api-key",
  "mode": "sandbox",
  "open_loop_url": "https://example.com/resource",
  "secret_key": "example-api-key",
  "shard_id": "12345",
  "user_id": "12345"
};

const result = await connectors.healthie.createClient(config).getGoals(body);
```

## cURL

```bash
curl -X POST \
  -H 'Authorization: Bearer <ACCESS_TOKEN>' \
  -H 'Content-Type: application/json' \
  -d '{"api_url":"https://example.com/resource","keywords":"example-api-key","mode":"sandbox","open_loop_url":"https://example.com/resource","secret_key":"example-api-key","shard_id":"12345","user_id":"12345"}' \
  'https://dev-api-connectors.health.cloud/connectors/healthie/get-goals'
```

## 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.