---
title: "GET /collections/{id}/matches"
method: GET
path: "/collections/{id}/matches"
tags: ["Collections"]
---

# GET /collections/{id}/matches

`GET /collections/{id}/matches`

## Path parameters

- `id` string, required

## Query parameters

- `perPage` number, double
- `page` number, double
- `filter` string — A string in the form `<FilterProperty>(<FilterOperator>(<FilterValue>))[,FilterExpressions]`. See the [API Reference](https://physna.github.io/public-api-guide/api-reference/filter-expressions) for more details. Example: ``` id(between(1,1000)),createdAt(not(lt('2022-01-01T00:00:00.000Z'))) ```

## Headers

- `X-PHYSNA-TENANTID` string

## Response `200`

Ok

- GetCollectionMatchesResponseBody
  - `matches` CollectionMatchResult[], required
    - `matchedCollection` CollectionWithMetadata, required
      - `id` string, required
      - `name` string
      - `createdAt` string
      - `thumbnails` string[]
      - `tag` string
      - `metadata` CollectionMetadata[]
        - `metadataKeyId` number, double, required
        - `collectionId` string, required
        - `name` string, required
        - `value` string, required
    - `matchScore` number, double
  - `filterData` object, required
    - `collections` CollectionFilterData, required
      - `names` string[], required
      - `tags` string[], required
      - `metadata` MetadataFilterData[], required
        - `metadataKeyId` number, double, required
        - `name` string, required
        - `values` string[], required
  - `page` number, double, required
  - `perPage` number, double, required
  - `total` number, double, required

## Other responses

- `503`

---

[API](https://skmtc.dev/physna/apis/physna-public-api.md) · [All operations](https://skmtc.dev/physna/apis/physna-public-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/physna/physna-public-api/revisions/18b6af4c004d/schema)