---
title: "Search digitised objects"
method: GET
path: "/v1/digitised-objects/search"
tags: ["V1", "Digitised Objects", "Search"]
---

# Search digitised objects

`GET /v1/digitised-objects/search`

## Request

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

Performs a keyword search with filters on the digitised objects present in the system.

## Query parameters

- `page` number
- `page.size` number
- `page.start` number
- `q` string
- `q.advanced` string
- `sort` 'relevance' | 'title.asc' | 'title.desc' | 'date.asc' | 'date.desc' | 'createdAt.desc'
- `filter.collection` union
  - string
  - string[]
- `filter.collection.id` union
  - string
  - string[]
- `filter.subject` union
  - string
  - string[]
- `filter.thematicCategory` union
  - string
  - string[]
- `filter.date.from` number
- `filter.date.to` number
- `filter.hasTEI` union
  - string
  - string[]
- `filter.hasTranscript` union
  - string
  - string[]
- `scope` string

## Response `200`

The list of items matching the given search query.

- object
  - `items` object[], nullable, required
    - `id` string, required
    - `refCode` string, nullable, required
    - `title` string, nullable, required
    - `description` string, nullable, required
    - `format` string, nullable, required
    - `language` string, nullable, required
    - `creators` string[], nullable, required
    - `subjects` string[], nullable, required
    - `dates` string[], nullable, required
    - `places` string[], nullable, required
    - `canvas` string, required
    - `highlights` object, required: The list of all matches for the given query per searched field.
      - `title` string[], required
      - `description` string[], required
      - `content` string[], 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.
  - `sort` Sort, required
    - `options` SortOption[], required
      - `id` string, required
      - `name` string, required
      - `_links` object, required
        - `activate` 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.
        - `deactivate` 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.
    - `active` object, nullable, required
      - `id` string, required
      - `name` string, required
      - `_links` object, required
        - `activate` 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.
        - `deactivate` 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` object, required: Standard set of links related to sorting.
      - `reset` 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.
  - `query` CancellableQuery, required
    - `value` string, nullable, required
    - `_links` object, required
      - `deactivate` 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.
  - `filters` Filters, required
    - `options` FilterOption[], required
      - `id` string, required
      - `name` string, required
      - `active` FilterValue[], nullable, required
        - `id` string, required
        - `name` string, required
        - `_links` object, required
          - `activate` 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.
          - `deactivate` 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.
      - `facets` Facet[], nullable, required
        - `id` string, required
        - `name` string, required
        - `count` number, required
        - `_links` object
          - `activate` 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.
          - `deactivate` 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.
      - `_links` object, required
        - `reset` 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.
    - `_links` object, required
      - `reset` 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.
  - `_links` object, 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.
    - `index` 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.
- `404`: Digitised objects matching the given criteria were not found.
- `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)