---
title: "List Criteria Templates"
url: "https://dev-portal.dehaven.org/apis/konnect-service-catalog-1-2-0/versions/5f6559bf-d7ba-429c-95c4-cbf2371e663f/operations/list-criteria-templates"
---

> Full API specification: https://dev-portal.dehaven.org/apis/konnect-service-catalog-1-2-0/versions/5f6559bf-d7ba-429c-95c4-cbf2371e663f.md

# List Criteria Templates

`GET` `/criteria-templates`

Operation ID: `list-criteria-templates`

Returns a paginated collection of criteria templates.

## Query parameters

- `filter` (object, optional) - Filters a collection of criteria templates.
- `sort` (optional) - Sorts a collection of criteria templates. Supported sort attributes are: - `display_name` - `name` Default sort is `display_name` in ascending order.

## Responses

- `200` - A paginated list response for a collection of criteria templates.

## OpenAPI definition

```yaml
openapi: 3.0.3
info:
  title: Konnect Service Catalog
  version: 1.2.0
servers:
  - url: https://us.api.konghq.com/v1
    description: US Region Base URL
  - url: https://eu.api.konghq.com/v1
    description: EU Region Base URL
  - url: https://au.api.konghq.com/v1
    description: AU Region Base URL
  - url: https://me.api.konghq.com/v1
    description: ME Region Base URL
  - url: https://in.api.konghq.com/v1
    description: IN Region Base URL
paths:
  /criteria-templates:
    get:
      x-unstable: true
      x-internal: true
      summary: List Criteria Templates
      operationId: list-criteria-templates
      description: Returns a paginated collection of criteria templates.
      parameters:
        - $ref: "#/components/parameters/CriteriaTemplateFilter"
        - $ref: "#/components/parameters/CriteriaTemplateSort"
      responses:
        "200":
          $ref: "#/components/responses/ListCriteriaTemplatesResponse"
      tags:
        - Criteria Templates
security:
  - konnectAccessToken: []
  - personalAccessToken: []
  - systemAccountAccessToken: []
components:
  parameters:
    CriteriaTemplateFilter:
      name: filter
      description: Filters a collection of criteria templates.
      required: false
      in: query
      style: deepObject
      schema:
        $ref: "#/components/schemas/CriteriaTemplateFilterParameters"
    CriteriaTemplateSort:
      name: sort
      description: |
        Sorts a collection of criteria templates. Supported sort attributes are:
          - `display_name`
          - `name`

        Default sort is `display_name` in ascending order.
      required: false
      in: query
      schema: {}
  responses:
    ListCriteriaTemplatesResponse:
      description: A paginated list response for a collection of criteria templates.
      content:
        application/json:
          schema:
            type: object
            additionalProperties: false
            properties:
              meta: {}
              data:
                type: array
                items:
                  $ref: "#/components/schemas/CriteriaTemplate"
            required:
              - meta
              - data
  schemas:
    CriteriaTemplateFilterParameters:
      type: object
      properties: {}
    CriteriaTemplate:
      type: object
      description: Representation of a criteria template.
      required:
        - name
        - display_name
        - template_string
        - integration_name
        - installed
        - schema
      properties:
        name:
          type: string
          description: Unique name that identifies the template.
          example: time_to_merge
        display_name:
          type: string
          description: The human-readable display name of the template.
        template_string:
          type: string
          nullable: true
          description: "[Liquid](https://shopify.github.io/liquid/) template string used
            to render the criteria interpolated by parameters."
        integration_name:
          type: string
          nullable: true
          description: >
            The catalog integration who registered the given criteria template.

            This will be `null` when a template is always available independent
            of connected integrations.
        installed:
          type: boolean
          description: >
            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:
          $ref: "#/components/schemas/CriteriaTemplateSchema"
    CriteriaTemplateSchema:
      oneOf:
        - nullable: true
        - x-flatten-allOf: true
          allOf:
            - $ref: "#/components/schemas/SimpleSchema"
            - type: object
              title: CriteriaTemplateSimpleSchema
              nullable: true
              description: >
                Defines the parameters required to evaluate the criteria using
                simple schema.

                Set to `null` when the given criteria does not rely on
                parameterization.
        - x-flatten-allOf: true
          allOf:
            - $ref: "#/components/schemas/JSONSchema"
            - type: object
              title: CriteriaTemplateJSONSchema
              nullable: true
              description: >
                Defines the parameters required to evaluate the criteria using
                JSON schema.

                Set to `null` when the given criteria does not rely on
                parameterization.
    SimpleSchema:
      type: object
      required:
        - type
        - definition
      properties:
        type:
          type: string
          enum:
            - simple
        definition:
          type: object
          additionalProperties:
            type: string
            enum:
              - string
              - number
              - boolean
    JSONSchema:
      type: object
      required:
        - type
        - definition
      properties:
        type:
          type: string
          enum:
            - json_schema
        definition:
          type: object
          additionalProperties: true
```