--- title: "Retrieve a coverage" url: "https://docs.unified.to/healthcare/coverage/Retrieve_a_coverage" description: "Retrieve a coverage with Unified's Coverage API (GET /healthcare/{connection_id}/coverage/{id}). Filter by fields and raw. Supported by 24 Coverage integrations." date: "2026-10-24T20:36:42.560Z" updated: "2026-10-24T20:36:42.560Z" --- # Retrieve a coverage Updated: October 24, 2026 GET/healthcare/{connection\_id}/coverage/{id} Retrieves a single HealthcareCoverage by its \`id\`. Obtain \`id\` values from the corresponding list endpoint. Use \`fields\` to return only the fields you need. ## Parameters **fields**string array id created\_at updated\_at patient\_id status codes payer\_name plan\_name group\_name group\_identifier member\_identifier subscriber\_name relationship priority start\_at end\_at identifiers metadata raw Fields to return **raw**string Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar **connection\_id**string required ID of the connection **id**string required ID of the Coverage ## Returns [HealthcareCoverage](https://docs.unified.to/healthcare/coverage/model.md) | Response field | Type | Required | Description | | ------------------------ | ----------------------------------------------------------------------------------------------------------------------- | -------- | ------------------------------------------------------------------------------------------ | | id | string | No | Unique identifier for the coverage | | created\_at | string (date-time) | No | When the coverage record was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) | | updated\_at | string (date-time) | No | When the coverage record was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) | | patient\_id | string | No | The patient covered by the insurance (beneficiary) | | status | enum | No | Status of the coverage Values: ACTIVE, CANCELLED, DRAFT, ENTERED\_IN\_ERROR, OTHER | | codes | [HealthcareCode](https://docs.unified.to/healthcare/coverage/Retrieve%5Fa%5Fcoverage.md#HealthcareCode)\[\] | No | Codings for the type of coverage (e.g. Medicare, commercial PPO) | | 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 | | payer\_name | string | No | Name of the insurer or payer | | plan\_name | string | No | Name of the insurance plan | | group\_name | string | No | Name of the employer group or plan group | | group\_identifier | string | No | Group number of the plan (reference to HrisGroup) | | member\_identifier | string | No | Member/subscriber number on the insurance card | | subscriber\_name | string | No | Name of the policy holder | | relationship | enum | No | Relationship of the patient to the policy holder Values: SELF, SPOUSE, CHILD, OTHER | | priority | number | No | Order in which the coverage is applied (1 = primary) | | start\_at | string (date-time) | No | When the coverage starts (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) | | end\_at | string (date-time) | No | When the coverage ends (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) | | identifiers | [HealthcareIdentifier](https://docs.unified.to/healthcare/coverage/Retrieve%5Fa%5Fcoverage.md#HealthcareIdentifier)\[\] | No | Business identifiers for the coverage | | identifiers\[\].value | string | Yes | The identifier value | | identifiers\[\].type | enum | No | The kind of identifier Values: MRN, NPI, SSN, DRIVERS\_LICENSE, PASSPORT, INSURANCE, OTHER | | identifiers\[\].system | string | No | The namespace/system URI that issued the identifier | | metadata | [HealthcareMetadata](https://docs.unified.to/healthcare/coverage/Retrieve%5Fa%5Fcoverage.md#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). ```json { "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`. ## Code Samples ### Node.js SDK ```javascript import { UnifiedTo } from '@unified-api/typescript-sdk'; const sdk = new UnifiedTo({ security: { jwt: '', }, }); const connectionId = '5de520f96e439b002043d8dc'; const id = '1234'; const results = await sdk.healthcare.getHealthcareCoverage({ connectionId, id, fields: '', raw: '', }); ``` ### Node.js (axios) ```javascript const options = { method: 'GET', url: 'https://api.unified.to/healthcare/5de520f96e439b002043d8dc/coverage/5de520f96e439b002043d8d8', headers: { authorization: 'bearer .....' }, params: { fields: '', raw: '', } }; const results = await axios.request(options); ``` ### Java ```java AsyncHttpClient client = new DefaultAsyncHttpClient(); client.prepare("GET", "https://api.unified.to/healthcare/5de520f96e439b002043d8dc/coverage/5de520f96e439b002043d8d8?fields=&raw=") .setHeader("accept", "application/json") .setHeader("authorization", ".....") .execute() .toCompletableFuture() .thenAccept(System.out::println) .join(); client.close(); ``` ### Go ```go import ( "fmt" "net/http" "io/ioutil" ) url := `https://api.unified.to/healthcare/5de520f96e439b002043d8dc/coverage/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 ```python import requests url = "https://api.unified.to/healthcare/5de520f96e439b002043d8dc/coverage/5de520f96e439b002043d8d8?fields=&raw=" headers = { "accept": "application/json", "authorization": "....." } response = requests.get(url, headers=headers) ``` ### PHP ```php $curl = curl_init(); curl_setopt_array($curl, [ CURLOPT_URL => "https://api.unified.to/healthcare/5de520f96e439b002043d8dc/coverage/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 ```ruby require 'uri' require 'net/http' require 'openssl' url = URI("https://api.unified.to/healthcare/5de520f96e439b002043d8dc/coverage/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 ```bash curl --request GET \ --url 'https://api.unified.to/healthcare/5de520f96e439b002043d8dc/coverage/5de520f96e439b002043d8d8?fields=&raw=' \ --header 'accept: application/json' \ --header 'authorization: .....' ```