---
title: "List of collections"
method: GET
path: "/v1/collections"
tags: ["V1", "Collections", "Index"]
---

# List of collections

`GET /v1/collections`

## Request

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

Returns summary of collections present in the system.

## Query parameters

- `page` number
- `page.size` number
- `page.start` number

## Response `200`

The list of collections matching a query.

- object
  - `items` object[], nullable, required
    - `id` string, required
    - `title` string, nullable, required
    - `_links` object, required
      - `definition` HateoasLink, required
        - `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.
  - `pagination` Pagination, required: Defines the metadata for the pagination used for providing the data on the given endpoint.
    - `size` number, required: Represents how many items can be presented on one page.
    - `totalPages` number, required: Represents how many pages are in total to fetch.
    - `totalElements` number, required: Represents how many items are in total to fetch.
    - `number` number, required: Represents the current page's number.
    - `_links` object, required: Standard set of links related to pagination.
      - `first` HateoasLink, required
        - `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.
      - `previous` 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.
      - `next` 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.
      - `last` HateoasLink, required
        - `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.
  - `_links` HomeLinks, required: Standard set of links related to the homepage.
    - `home` HateoasLink, required
      - `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

- `400`: The server could not finalise the response due to the malformed, invalid or missing request parameters.
- `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)