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

# Search digitised objects autocompletion

`GET /v1/digitised-objects/search/autocomplete`

## Request

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

Provides search box autocompletion for the given phrase.

## Query parameters

- `q` string, required
- `page.size` number
- `scope` string

## Response `200`

The list of terms/phrases matching the given query.

- AutocompleteResponse
  - `items` object[], nullable, required
    - `title` string, required
    - `highlight` string, required
  - `query` ReadonlyQuery, required
    - `value` string, nullable, required
  - `_links` object, required
    - `search` 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`: No suggestions were available for the given query.
- `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)