---
title: "List Criteria Templates"
method: GET
path: "/v1/criteria-templates"
tags: ["Criteria Templates"]
---

# List Criteria Templates

`GET /v1/criteria-templates`

Returns a paginated collection of criteria templates.

## Query parameters

- `page[size]` integer
- `page[number]` integer
- `filter` CriteriaTemplateFilterParameters
  - `name` StringFieldFilter — Filter using **one** of the following operators: `eq`, `oeq`, `neq`, `contains`, `ocontains`
    - `eq` string — The field exactly matches the provided value.
    - `contains` string — The field contains the provided value.
    - `ocontains` string — The field contains any of the provided values.
    - `oeq` string — The field matches any of the provided values.
    - `neq` string — The field does not match the provided value.
  - `display_name` StringFieldFilter — Filter using **one** of the following operators: `eq`, `oeq`, `neq`, `contains`, `ocontains`
    - `eq` string — The field exactly matches the provided value.
    - `contains` string — The field contains the provided value.
    - `ocontains` string — The field contains any of the provided values.
    - `oeq` string — The field matches any of the provided values.
    - `neq` string — The field does not match the provided value.
  - `installed` boolean — Filter by a boolean value (true/false).
  - `integration_name` StringFieldFilter — Filter using **one** of the following operators: `eq`, `oeq`, `neq`, `contains`, `ocontains`
    - `eq` string — The field exactly matches the provided value.
    - `contains` string — The field contains the provided value.
    - `ocontains` string — The field contains any of the provided values.
    - `oeq` string — The field matches any of the provided values.
    - `neq` string — The field does not match the provided value.
- `sort` string — The `asc` suffix is optional as the default sort order is ascending. The `desc` suffix is used to specify a descending order. Multiple sort attributes may be provided via a comma separated list. JSONPath notation may be used to specify a sub-attribute (eg: 'foo.bar desc').

## Response `200`

A paginated list response for a collection of criteria templates.

- object
  - `meta` PaginatedMeta, required — returns the pagination information
    - `page` PageMeta, required — Contains pagination query parameters and the total number of objects returned.
      - `number` number, required
      - `size` number, required
      - `total` number, required
  - `data` CriteriaTemplate[], required
    - `name` string, required — Reference to the unique `name` of the criteria template.
    - `display_name` string, required — The human-readable display name of the template.
    - `category` 'Source Code Management' | 'Incident Management' | 'Observability' | 'Code Quality' | 'Issue Tracking' | 'Communications' | 'Feature Management' | 'Security / Vulnerability' | 'Documentation' | 'Catalog Management' | 'Gateway Configuration', nullable, required — Categorical tag for the functionality the template relates to.
    - `template_string` string, nullable, required — [Liquid](https://shopify.github.io/liquid/) template string used to render the criteria interpolated by parameters.
    - `integration_name` string, nullable, required — The catalog integration who registered the given criteria template. This will be `null` when a template is always available independent of connected integrations.
    - `installed` boolean, required — Whether the template is available given the current state of the catalog. For example, this will be `false` when the template is provided by an integrastion that is not currently connected.
    - `schema` union, required
      - object, nullable
      - object — Defines the parameters required to evaluate the criteria using simple schema. Set to `null` when the given criteria does not rely on parameterization.
        - `type` 'simple', required
        - `definition` object, required
      - object — Defines the parameters required to evaluate the criteria using JSON schema. Set to `null` when the given criteria does not rely on parameterization.
        - `type` 'json_schema', required
        - `definition` object, required
    - `required_integration_capability` 'null' | 'on_call_provider' | 'incident_provider' | 'pull_request_provider' | 'workflow_provider', nullable, required — Required capability from connected integrations to use this criteria template. Applicable for templates that are not provided by a given integration (functional across integrations).

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `403` — Forbidden

---

[API](https://skmtc.net/kong/apis/konnect-api-go-sdk.md) · [All operations](https://skmtc.net/kong/apis/konnect-api-go-sdk/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/kong/konnect-api-go-sdk/revisions/b1ea6bd77dec/schema)