---
title: "Retrieve information about this API and its relationship with HSDS."
method: GET
path: "/"
tags: ["required"]
---

# Retrieve information about this API and its relationship with HSDS.

`GET /`

Retrieve information about this API and its relationship with HSDS.

## Response `200`

A JSON response providing information about this API.

- object
  - `version` string — HSDS version of this API.
  - `profile` string, uri — URL of the information on the HSDS profile of this API.
  - `openapi_url` string, uri — URL of the openapi JSON file which defines this API.
  - `description` string — A human-readable description of this API feed
  - `data_guide` string, uri — A URI to a human-readable data guide which can support people understanding this dataset.
  - `publisher` object
    - `name` string — The name of the publisher of this API feed.
    - `identifier` string — An organization identifier string formatted according to org-id.guide e.g. GB-COH-123456.
    - `email` string, email — An email address that can be used to submit feedback about data in this feed.
    - `website` string, uri — A URL that can be used to submit feedback about data in this feed.
    - `additional_websites` string[] — Additional URLs that can be used to contact the Publisher about data in this feed.

---

[API](https://skmtc.net/openreferral/apis/required-title-of-your-api-here.md) · [All operations](https://skmtc.net/openreferral/apis/required-title-of-your-api-here/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/openreferral/required-title-of-your-api-here/revisions/86dad57d605b/schema)