---
title: "Get the CapabilityStatement"
url: "https://docs.unified.to/fhir/metadata/Get_the_CapabilityStatement"
description: "Get the CapabilityStatement with Unified's Metadata API (GET /fhir/{connection_id}/metadata)."
date: "2026-11-20T18:13:18.192Z"
updated: "2026-11-20T18:13:18.192Z"
---
# Get the CapabilityStatement

Updated: November 20, 2026

 GET/fhir/{connection\_id}/metadata

The resources, interactions and search parameters this connection's integration supports. Responses use the application/fhir+json media type; errors are OperationOutcome resources. Read-only (FHIR R4 4.0.1).

## Parameters

**connection\_id**string  required 

ID of the connection

## Returns

[FhirCapabilityStatement](https://docs.unified.to/fhir/metadata/model.md)

| Response field                                      | Type                                   | Required | Description                                                                                                                                                                                     |                                          |
| --------------------------------------------------- | -------------------------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------- |
| resourceType                                        | enum                                   | Yes      | Always CapabilityStatement Values: Patient, Practitioner, Encounter, Observation, Condition, AllergyIntolerance, MedicationRequest, Immunization, Bundle, OperationOutcome, CapabilityStatement |                                          |
| status                                              | enum                                   | Yes      | active Values: active                                                                                                                                                                           |                                          |
| date                                                | string                                 | Yes      | Date last changed                                                                                                                                                                               |                                          |
| kind                                                | enum                                   | Yes      | instance Values: instance                                                                                                                                                                       |                                          |
| software                                            | object                                 | No       | Software that is covered by this capability statement                                                                                                                                           |                                          |
| software.name                                       | string                                 | Yes      | A name the software is known by                                                                                                                                                                 |                                          |
| implementation                                      | object                                 | No       | If this describes a specific instance                                                                                                                                                           |                                          |
| implementation.description                          | string                                 | Yes      | Describes this specific instance                                                                                                                                                                |                                          |
| implementation.url                                  | string                                 | No       | Base URL for the installation                                                                                                                                                                   |                                          |
| fhirVersion                                         | string                                 | Yes      | FHIR Version the system supports (4.0.1)                                                                                                                                                        |                                          |
| format                                              | string\[\]                             | No       | formats supported (json, application/fhir+json)                                                                                                                                                 |                                          |
| rest                                                | FhirCapabilityStatementRest\[\]        | No       | If the endpoint is a RESTful one                                                                                                                                                                |                                          |
| rest\[\].mode                                       | enum                                   | Yes      | server Values: server                                                                                                                                                                           |                                          |
| rest\[\].documentation                              | string                                 | No       | General description of implementation                                                                                                                                                           |                                          |
| rest\[\].security                                   | FhirCapabilityStatementRest\_security  | No       | Information about security of implementation                                                                                                                                                    |                                          |
| rest\[\].security.description                       | string                                 | No       | General description of how security works                                                                                                                                                       |                                          |
| rest\[\].resource                                   | FhirCapabilityStatementResource\[\]    | No       | Resource served on the REST interface                                                                                                                                                           |                                          |
| rest\[\].resource\[\].type                          | string                                 | Yes      | A resource type that is supported                                                                                                                                                               |                                          |
| rest\[\].resource\[\].interaction                   | FhirCapabilityStatementInteraction\[\] | No       | What operations are supported?                                                                                                                                                                  |                                          |
| rest\[\].resource\[\].interaction\[\].code          | enum                                   | Yes      | read \| search-type Values: read, search-type                                                                                                                                                   |                                          |
| rest\[\].resource\[\].searchParam                   | FhirCapabilityStatementSearchParam\[\] | No       | Search parameters supported by implementation                                                                                                                                                   |                                          |
| rest\[\].resource\[\].searchParam\[\].name          | string                                 | Yes      | Name of search parameter                                                                                                                                                                        |                                          |
| rest\[\].resource\[\].searchParam\[\].type          | enum                                   | Yes      | token \| date                                                                                                                                                                                   | reference Values: token, date, reference |
| rest\[\].resource\[\].searchParam\[\].documentation | string                                 | No       | Server-specific usage                                                                                                                                                                           |                                          |

## 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: '<YOUR_API_KEY_HERE>',
    },
});

const connectionId = '5de520f96e439b002043d8dc';

const results = await sdk.fhir.listFhirMetadatas({ connectionId, 

 });
```

### Node.js (axios)

```javascript
const options = {
  method: 'GET',
  url: 'https://api.unified.to/fhir/5de520f96e439b002043d8dc/metadata',
  headers: {
    authorization: 'bearer .....'
  },

};

const results = await axios.request(options);
```

### Java

```java
AsyncHttpClient client = new DefaultAsyncHttpClient();

client.prepare("GET", "https://api.unified.to/fhir/5de520f96e439b002043d8dc/metadata")
  .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/fhir/5de520f96e439b002043d8dc/metadata

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/fhir/5de520f96e439b002043d8dc/metadata"

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/fhir/5de520f96e439b002043d8dc/metadata",
  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/fhir/5de520f96e439b002043d8dc/metadata")

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/fhir/5de520f96e439b002043d8dc/metadata' \
  --header 'accept: application/json' \
  --header 'authorization: .....'
```
