Retrieve a goal

Updated: October 24, 2026

GET/healthcare/{connection_id}/goal/{id}

Retrieves a single HealthcareGoal by its `id`. Obtain `id` values from the corresponding list endpoint. Use `fields` to return only the fields you need.

Parameters

Returns

HealthcareGoal

Response field	Type	Required	Description
`id`	string	No	Unique identifier for the goal
`created_at`	string (date-time)	No	When the goal record was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
`updated_at`	string (date-time)	No	When the goal record was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
`patient_id`	string	No	The patient the goal is for
`practitioner_id`	string	No	The practitioner who set the goal
`condition_ids`	string[]	No	Conditions the goal addresses
`name`	string	No	Human-readable description of the goal
`codes`	HealthcareCode[]	No	Codings for the goal
`codes[].system`	string	No	The code system URI (e.g. http://loinc.org, http://snomed.info/sct)
`codes[].code`	string	No	The code within the system
`codes[].display`	string	No	Human-readable display text for the code
`status`	enum	No	Lifecycle status of the goal Values: `PROPOSED`, `PLANNED`, `ACCEPTED`, `ACTIVE`, `ON_HOLD`, `COMPLETED`, `CANCELLED`, `ENTERED_IN_ERROR`, `REJECTED`, `OTHER`
`achievement_status`	enum	No	Progress towards the goal Values: `IN_PROGRESS`, `IMPROVING`, `WORSENING`, `NO_CHANGE`, `ACHIEVED`, `SUSTAINING`, `NOT_ACHIEVED`, `NO_PROGRESS`, `NOT_ATTAINABLE`, `OTHER`
`start_at`	string (date-time)	No	When work on the goal starts (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
`due_at`	string (date-time)	No	When the goal should be reached (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
`notes`	string	No	Free-text notes about the goal
`metadata`	HealthcareMetadata[]	No	Custom field values
`metadata[].id`	string	No	Identifier of the custom field
`metadata[].value`	object	No	The custom field value
`metadata[].namespace`	string	No	The scope or origin of the custom field
`metadata[].format`	enum	No	The data type of the value Values: `TEXT`, `NUMBER`, `DATE`, `BOOLEAN`, `ARRAY`, `OBJECT`
`metadata[].extra_data`	object	No	Additional data about the custom field
`metadata[].slug`	string	No	The custom field key

Errors

Errors return the HTTP status code and a JSON body with statusCode, error (the short label) and message (a human-readable detail).

{
  "statusCode": 429,
  "error": "Too Many Requests",
  "message": "Too many requests to unified.to API; max requests per minute: N"
}

Status	Error	Meaning
`400`	Bad Request	The request was malformed or failed validation.
`401`	Unauthorized	The connection is likely broken; re-authorize it.
`403`	Forbidden	The connection is missing permissions or scopes.
`404`	Not Found	The requested resource does not exist.
`429`	Too Many Requests	Rate limit exceeded (see the two sources below).
`500`	Internal Server Error	An unexpected error occurred.
`501`	Not Implemented	Not supported by this integration.

Errors from the underlying integration pass through: the integration's status comes back as ours (429, 401, 403, 404 or 5xx), usually with its message. When the integration's error body is unclear, Unified extracts what it can and returns a clearer message.

429 Too Many Requests

A 429 has two possible sources:

The integration's own rate limit, passed through.
Unified's workspace limit: a rolling 60 seconds, set by plan, with the message Too many requests to unified.to API; max requests per minute: N.

const options = {
  method: 'GET',
  url: 'https://api.unified.to/healthcare/5de520f96e439b002043d8dc/goal/5de520f96e439b002043d8d8',
  headers: {
    authorization: 'bearer .....'
  },
  params: {
    fields: '',
    raw: '',
  }
};

const results = await axios.request(options);

Code Samples

Node.js SDK

import { UnifiedTo } from '@unified-api/typescript-sdk';

const sdk = new UnifiedTo({
    security: {
        jwt: '<YOUR_API_KEY_HERE>',
    },
});

const connectionId = '5de520f96e439b002043d8dc';

const id = '1234';

const results = await sdk.healthcare.getHealthcareGoal({ connectionId, id, 
    fields: '',
    raw: '',
 });

Node.js (axios)

const options = {
  method: 'GET',
  url: 'https://api.unified.to/healthcare/5de520f96e439b002043d8dc/goal/5de520f96e439b002043d8d8',
  headers: {
    authorization: 'bearer .....'
  },
  params: {
    fields: '',
    raw: '',
  }
};

const results = await axios.request(options);

Java

AsyncHttpClient client = new DefaultAsyncHttpClient();

client.prepare("GET", "https://api.unified.to/healthcare/5de520f96e439b002043d8dc/goal/5de520f96e439b002043d8d8?fields=&raw=")
  .setHeader("accept", "application/json")
  .setHeader("authorization", ".....")
  .execute()
  .toCompletableFuture()
  .thenAccept(System.out::println)
  .join();

client.close();

Go

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

url := `https://api.unified.to/healthcare/5de520f96e439b002043d8dc/goal/5de520f96e439b002043d8d8?fields=&raw=

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("accept", "application/json")
req.Header.Add("authorization", ".....")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)

Python

import requests

url = "https://api.unified.to/healthcare/5de520f96e439b002043d8dc/goal/5de520f96e439b002043d8d8?fields=&raw="

headers = {
    "accept": "application/json",
    "authorization": "....."
}

response = requests.get(url, headers=headers)

PHP

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.unified.to/healthcare/5de520f96e439b002043d8dc/goal/5de520f96e439b002043d8d8?fields=&raw=",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "accept: application/json",
    "authorization: ....."
  ],
]);

Ruby

require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://api.unified.to/healthcare/5de520f96e439b002043d8dc/goal/5de520f96e439b002043d8d8?fields=&raw=")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["accept"] = 'application/json'
request["authorization"] = '....'

response = http.request(request)
puts response.read_body

cURL

curl --request GET \
  --url 'https://api.unified.to/healthcare/5de520f96e439b002043d8dc/goal/5de520f96e439b002043d8d8?fields=&raw=' \
  --header 'accept: application/json' \
  --header 'authorization: .....'

Are we missing anything? Let us know

Was this page helpful?