---
title: "The API's home page"
method: GET
path: "/"
tags: ["API Metadata Information"]
---

# The API's home page

`GET /`

## Request

- Base URL: `https://api-dor.ncl.ac.uk`
- URL: `https://api-dor.ncl.ac.uk/`
- Auth: none declared

Returns an OpenAPI interactive documentation for devices requesting HTML, or starting HATEAOS links for JSON requests.

## Response `200`

The API's starting point.

- object
  - `_links` object, required
    - `info` HateoasLink
      - `href` string, required
      - `type` 'GET' | 'POST' | 'PUT' | 'DELETE', required
      - `parameters` HateoasParameters: Any relevant parameters that should be appended to the URL (for GET method) or passed as a payload for other HTTP methods.
    - `collections` HateoasLink
      - `href` string, required
      - `type` 'GET' | 'POST' | 'PUT' | 'DELETE', required
      - `parameters` HateoasParameters: Any relevant parameters that should be appended to the URL (for GET method) or passed as a payload for other HTTP methods.
    - `digitisedObjects` HateoasLink
      - `href` string, required
      - `type` 'GET' | 'POST' | 'PUT' | 'DELETE', required
      - `parameters` HateoasParameters: Any relevant parameters that should be appended to the URL (for GET method) or passed as a payload for other HTTP methods.
    - `items` HateoasLink
      - `href` string, required
      - `type` 'GET' | 'POST' | 'PUT' | 'DELETE', required
      - `parameters` HateoasParameters: Any relevant parameters that should be appended to the URL (for GET method) or passed as a payload for other HTTP methods.

## Other responses

- `5XX`: Indicates that the server encountered an unexpected exception preventing it from fulfilling the request.

---

[API](https://skmtc.dev/ncl/apis/newcastle-university-digitised-objects-repository-search-and.md) - [All operations](https://skmtc.dev/ncl/apis/newcastle-university-digitised-objects-repository-search-and/llms.txt) - [OpenAPI document](https://skmtc.dev/ncl/apis/newcastle-university-digitised-objects-repository-search-and/revisions/fe6a8df13009?raw)