---
title: "List Post Matches"
method: GET
path: "/wordlift/v1/post-matches"
tags: ["Post Matches"]
---

# List Post Matches

`GET /wordlift/v1/post-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/post-matches`
- Auth: none declared
- TypeScript: <https://skmtc.dev/insideout10/apis/wordlift-plugin/docs/wordlift/v1/post-matches/get.ts> (a function with typed inputs; its response is checked against the schema)

List the post matches

## Query parameters

- `cursor` string
- `limit` integer
- `post_types` string[]
- `has_match` boolean
- `post_status` 'publish' | 'draft'
- `sort` '+date_modified_gmt' | '-date_modified_gmt'

## Response `200`

The list of post matches

- PagePostMatch
  - `first` string
  - `prev` string
  - `next` string
  - `last` string
  - `items` PostMatch[]
    - `id` integer, required
    - `post_title` string, required
    - `post_status` string, required
    - `parent_post_title` string
    - `parent_post_id` string
    - `parent_post_link` string
    - `match_jsonld` string
    - `match_id` integer
    - `match_name` string
    - `post_link` string, required
    - `view_link` string, required
    - `preview_link` string, required

## Other responses

- `401`: Unauthorized
- `403`: Forbidden

## Changes

- **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/post-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)