---
title: "GET /wordlift/v1/term-matches"
method: GET
path: "/wordlift/v1/term-matches"
tags: ["Term Matches"]
---

# GET /wordlift/v1/term-matches

`GET /wordlift/v1/term-matches`

## Request

- Base URL: `https` (relative, and the document was published on a file host, not at the API’s origin)
- URL: `https/wordlift/v1/term-matches`
- Auth: none declared
- TypeScript: <https://skmtc.dev/insideout10/apis/wordlift-plugin/docs/wordlift/v1/term-matches/get.ts> (a function with typed inputs; its response is checked against the schema)

Returns a list of term matches for a given taxonomy.

## Query parameters

- `cursor` string
- `limit` number
- `has_match` boolean
- `term_contains` string
- `sort` '+term_name' | '-term_name' | '+entity_name' | '-entity_name' | '+ingredient_term' | '-ingredient_term' | '+matched_ingredient' | '-matched_ingredient' | '+occurrences' | '-occurrences'

## Response `200`

OK

- PageTermMatch
  - `self` string: The URL of the current page.
  - `first` string: The URL of the first page.
  - `prev` string: The URL of the previous page.
  - `next` string: The URL of the next page.
  - `last` string: The URL of the last page.
  - `items` TermMatch[]
    - `name` string, required: The name of the term
    - `id` integer, required: The ID of the term.
    - `match_name` string, required: The name of the matched term.
    - `match_id` integer, required: The ID of the matched term.
    - `match_jsonld` string: The JSON-LD of the matched term.
    - `occurrences` integer, required: The number of times the term is used.

## Changes

- **2026-07-17** `00576e6d31eb`: 1 breaking, 1 warning, 5 info
  - added the new required `query` request parameter `taxonomies`
  - deleted the `query` request parameter `taxonomy`
  - added the new optional `query` request parameter `term_contains`
  - added the new enum value `+entity_name` to the `query` request parameter `sort`
  - …3 more
- **2023-07-13** `1cff586b2a8d`: 1 breaking, 1 info
  - the `items/items/match_jsonld` response's property type changed from `object` to `string` for status `200`
  - added the new optional `query` request parameter `sort`
- **2023-07-13** `18ae40c3d22f`: 1 info
  - endpoint added
- **2023-04-17** `f968547046e0`: 1 breaking
  - api path removed without deprecation

[Operation history](https://skmtc.dev/insideout10/apis/wordlift-plugin/changes/wordlift/v1/term-matches/get.md)

---

[API](https://skmtc.dev/insideout10/apis/wordlift-plugin.md) - [All operations](https://skmtc.dev/insideout10/apis/wordlift-plugin/llms.txt) - [OpenAPI document](https://skmtc.dev/insideout10/apis/wordlift-plugin/revisions/00576e6d31eb?raw)