---
title: "List Criteria Templates"
url: "https://us-prod.jeffyongtaotang.com/apis/konnect-service-catalog-1/versions/cdbef9b7-686c-4189-bbc8-55c727a972e8/operations/list-criteria-templates"
---

> Full API specification: https://us-prod.jeffyongtaotang.com/apis/konnect-service-catalog-1/versions/cdbef9b7-686c-4189-bbc8-55c727a972e8.md

# List Criteria Templates

`GET` `/criteria-templates`

Operation ID: `list-criteria-templates`

Returns a paginated collection of criteria templates.

## Query parameters

- `page[size]` (integer, optional) - The maximum number of items to include per page. The last page of a collection may include fewer items.
- `page[number]` (integer, optional) - Determines which page of the entities to retrieve.
- `filter` (object, optional) - Filters a collection of criteria templates.
- `sort` (string, 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.
- `400` - Bad Request
- `401` - Unauthorized
- `403` - Forbidden

## OpenAPI definition

```yaml
openapi: 3.0.3
info:
  title: Konnect Service Catalog
  version: 1.3.0
servers:
  - url: https://us.api.konghq.com/v1
    description: United-States Production region
  - url: https://eu.api.konghq.com/v1
    description: Europe Production region
  - url: https://au.api.konghq.com/v1
    description: Australia Production region
  - url: https://me.api.konghq.com/v1
    description: Middle-East Production region
  - url: https://in.api.konghq.com/v1
    description: India Production region
  - url: https://sg.api.konghq.com/v1
    description: Singapore Production region
paths:
  /criteria-templates:
    get:
      summary: List Criteria Templates
      operationId: list-criteria-templates
      description: Returns a paginated collection of criteria templates.
      parameters:
        - $ref: "#/components/parameters/PageSize"
        - $ref: "#/components/parameters/PageNumber"
        - $ref: "#/components/parameters/CriteriaTemplateFilter"
        - $ref: "#/components/parameters/CriteriaTemplateSort"
      responses:
        "200":
          $ref: "#/components/responses/ListCriteriaTemplatesResponse"
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "403":
          $ref: "#/components/responses/Forbidden"
      tags:
        - Criteria Templates
security:
  - konnectAccessToken: []
  - personalAccessToken: []
  - systemAccountAccessToken: []
components:
  parameters:
    PageSize:
      name: page[size]
      description: The maximum number of items to include per page. The last page of a
        collection may include fewer items.
      required: false
      in: query
      allowEmptyValue: true
      schema:
        type: integer
        example: 10
    PageNumber:
      name: page[number]
      description: Determines which page of the entities to retrieve.
      required: false
      in: query
      allowEmptyValue: true
      schema:
        type: integer
        example: 1
    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:
        $ref: "#/components/schemas/SortQuery"
  responses:
    ListCriteriaTemplatesResponse:
      description: A paginated list response for a collection of criteria templates.
      content:
        application/json:
          schema:
            type: object
            additionalProperties: false
            properties:
              meta:
                $ref: "#/components/schemas/PaginatedMeta"
              data:
                type: array
                items:
                  $ref: "#/components/schemas/CriteriaTemplate"
            required:
              - meta
              - data
          examples:
            Criteria Templates:
              $ref: "#/components/examples/ListCriteriaTemplatesResponse"
    BadRequest:
      description: Bad Request
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/BadRequestError"
    Unauthorized:
      description: Unauthorized
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/UnauthorizedError"
          examples:
            UnauthorizedExample:
              $ref: "#/components/examples/UnauthorizedExample"
    Forbidden:
      description: Forbidden
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/ForbiddenError"
          examples:
            UnauthorizedExample:
              $ref: "#/components/examples/ForbiddenExample"
  schemas:
    CriteriaTemplateFilterParameters:
      type: object
      properties:
        name:
          $ref: "#/components/schemas/StringFieldFilter"
        display_name:
          $ref: "#/components/schemas/StringFieldFilter"
        installed:
          $ref: "#/components/schemas/BooleanFieldFilter"
        integration_name:
          $ref: "#/components/schemas/StringFieldFilter"
    SortQuery:
      title: SortQuery
      type: string
      example: created_at desc
      description: >
        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').
    PaginatedMeta:
      type: object
      title: PaginatedMeta
      x-speakeasy-terraform-ignore: true
      description: returns the pagination information
      properties:
        page:
          $ref: "#/components/schemas/PageMeta"
      required:
        - page
    CriteriaTemplate:
      type: object
      description: Representation of a criteria template.
      required:
        - name
        - display_name
        - category
        - template_string
        - integration_name
        - installed
        - schema
        - required_integration_capability
      properties:
        name:
          $ref: "#/components/schemas/CriteriaTemplateName"
        display_name:
          type: string
          description: The human-readable display name of the template.
        category:
          type: string
          enum:
            - Source Code Management
            - Incident Management
            - Observability
            - Code Quality
            - Issue Tracking
            - Communications
            - Feature Management
            - Security / Vulnerability
            - Documentation
            - Catalog Management
            - Gateway Configuration
          nullable: true
          description: Categorical tag for the functionality the template relates to.
          example: Source Code Management
        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"
        required_integration_capability:
          type: string
          nullable: true
          enum:
            - null
            - on_call_provider
            - incident_provider
            - pull_request_provider
            - workflow_provider
          description: >
            Required capability from connected integrations to use this criteria
            template.

            Applicable for templates that are not provided by a given
            integration (functional

            across integrations).
    BadRequestError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          required:
            - invalid_parameters
          properties:
            invalid_parameters:
              $ref: "#/components/schemas/InvalidParameters"
    UnauthorizedError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 401
            title:
              example: Unauthorized
            type:
              example: https://httpstatuses.com/401
            instance:
              example: kong:trace:1234567890
            detail:
              example: Invalid credentials
    ForbiddenError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 403
            title:
              example: Forbidden
            type:
              example: https://httpstatuses.com/403
            instance:
              example: kong:trace:1234567890
            detail:
              example: Forbidden
    StringFieldFilter:
      oneOf:
        - title: Filter by operator
          description: "Filter using **one** of the following operators: `eq`, `oeq`,
            `neq`, `contains`, `ocontains`"
          x-examples:
            example-1:
              contains: some-value
              ocontains: this-value,or-that-value
              oeq: some-value,some-other-value
              neq: not-this-value
            example-2:
              eq: some-value
          properties:
            eq:
              type: string
              description: The field exactly matches the provided value.
              example: ?filter[field_name_here][eq]=foo
            contains:
              type: string
              description: The field contains the provided value.
              example: ?filter[field_name_here][contains]=foo
            ocontains:
              type: string
              description: The field contains any of the provided values.
              example: ?filter[field_name_here][ocontains]=foo,bar
            oeq:
              type: string
              description: The field matches any of the provided values.
              example: ?filter[field_name_here][oeq]=foo,bar
            neq:
              type: string
              description: The field does not match the provided value.
              example: ?filter[field_name_here][neq]=bar
          type: object
          additionalProperties: false
        - title: Filter by exact string match
          type: string
          description: The field exactly matches the provided value.
          example: ?filter[title]=foo
    BooleanFieldFilter:
      title: BooleanFieldFilter
      description: Filter by a boolean value (true/false).
      type: boolean
      x-examples:
        example-1: true
    PageMeta:
      type: object
      description: Contains pagination query parameters and the total number of
        objects returned.
      required:
        - number
        - size
        - total
      properties:
        number:
          type: number
          example: 1
          x-speakeasy-terraform-ignore: true
        size:
          type: number
          example: 10
          x-speakeasy-terraform-ignore: true
        total:
          type: number
          example: 100
          x-speakeasy-terraform-ignore: true
    CriteriaTemplateName:
      type: string
      description: Reference to the unique `name` of the criteria template.
      example: time_to_merge
    CriteriaTemplateSchema:
      x-convert-oneOf: true
      anyOf:
        - title: EmptySchema
          type: object
          nullable: true
        - type: object
          required:
            - type
            - definition
          properties:
            type:
              type: string
              enum:
                - simple
            definition:
              type: object
              additionalProperties:
                type: string
                enum:
                  - string
                  - number
                  - boolean
          title: CriteriaTemplateSimpleSchema
          description: >
            Defines the parameters required to evaluate the criteria using
            simple schema.

            Set to `null` when the given criteria does not rely on
            parameterization.
        - type: object
          required:
            - type
            - definition
          properties:
            type:
              type: string
              enum:
                - json_schema
            definition:
              type: object
              additionalProperties: true
          title: CriteriaTemplateJSONSchema
          description: >
            Defines the parameters required to evaluate the criteria using JSON
            schema.

            Set to `null` when the given criteria does not rely on
            parameterization.
    BaseError:
      type: object
      title: Error
      description: standard error
      required:
        - status
        - title
        - instance
        - detail
      properties:
        status:
          type: integer
          description: >
            The HTTP status code of the error. Useful when passing the response

            body to child properties in a frontend UI. Must be returned as an
            integer.
          readOnly: true
        title:
          type: string
          description: |
            A short, human-readable summary of the problem. It should not
            change between occurences of a problem, except for localization.
            Should be provided as "Sentence case" for direct use in the UI.
          readOnly: true
        type:
          type: string
          description: The error type.
          readOnly: true
        instance:
          type: string
          description: |
            Used to return the correlation ID back to the user, in the format
            kong:trace:<correlation_id>. This helps us find the relevant logs
            when a customer reports an issue.
          readOnly: true
        detail:
          type: string
          description: >
            A human readable explanation specific to this occurence of the
            problem.

            This field may contain request/entity data to help the user
            understand

            what went wrong. Enclose variable values in square brackets. Should
            be

            provided as "Sentence case" for direct use in the UI.
          readOnly: true
    InvalidParameters:
      type: array
      nullable: false
      uniqueItems: true
      minItems: 1
      description: invalid parameters
      items:
        oneOf:
          - $ref: "#/components/schemas/InvalidParameterStandard"
          - $ref: "#/components/schemas/InvalidParameterMinimumLength"
          - $ref: "#/components/schemas/InvalidParameterMaximumLength"
          - $ref: "#/components/schemas/InvalidParameterChoiceItem"
          - $ref: "#/components/schemas/InvalidParameterDependentItem"
    InvalidParameterStandard:
      type: object
      additionalProperties: false
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          $ref: "#/components/schemas/InvalidRules"
        source:
          type: string
          example: body
        reason:
          type: string
          example: is a required field
          readOnly: true
      required:
        - field
        - reason
    InvalidParameterMinimumLength:
      type: object
      additionalProperties: false
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          readOnly: true
          nullable: false
          enum:
            - min_length
            - min_digits
            - min_lowercase
            - min_uppercase
            - min_symbols
            - min_items
            - min
        minimum:
          type: integer
          example: 8
        source:
          type: string
          example: body
        reason:
          type: string
          example: must have at least 8 characters
          readOnly: true
      required:
        - field
        - reason
        - rule
        - minimum
    InvalidParameterMaximumLength:
      type: object
      additionalProperties: false
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          readOnly: true
          nullable: false
          enum:
            - max_length
            - max_items
            - max
        maximum:
          type: integer
          example: 8
        source:
          type: string
          example: body
        reason:
          type: string
          example: must not have more than 8 characters
          readOnly: true
      required:
        - field
        - reason
        - rule
        - maximum
    InvalidParameterChoiceItem:
      type: object
      additionalProperties: false
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          readOnly: true
          nullable: false
          enum:
            - enum
        reason:
          type: string
          example: is a required field
          readOnly: true
        choices:
          type: array
          uniqueItems: true
          readOnly: true
          nullable: false
          minItems: 1
          items: {}
        source:
          type: string
          example: body
      required:
        - field
        - reason
        - rule
        - choices
    InvalidParameterDependentItem:
      type: object
      additionalProperties: false
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          readOnly: true
          nullable: true
          enum:
            - dependent_fields
        reason:
          type: string
          example: is a required field
          readOnly: true
        dependents:
          type: array
          uniqueItems: true
          nullable: true
          items: {}
          readOnly: true
        source:
          type: string
          example: body
      required:
        - field
        - rule
        - reason
        - dependents
    InvalidRules:
      description: invalid parameters rules
      type: string
      readOnly: true
      nullable: true
      enum:
        - required
        - is_array
        - is_base64
        - is_boolean
        - is_date_time
        - is_integer
        - is_null
        - is_number
        - is_object
        - is_string
        - is_uuid
        - is_fqdn
        - is_arn
        - unknown_property
        - missing_reference
        - is_label
        - matches_regex
        - invalid
        - is_supported_network_availability_zone_list
        - is_supported_network_cidr_block
        - is_supported_provider_region
        - type
  examples:
    ListCriteriaTemplatesResponse:
      value:
        data:
          - name: gateway_manager_error_rate
            display_name: Gateway Service Error Rate
            category: Observability
            template_string: Error rate is lower than {{ threshold }}% over {{
              relative_window }}
            installed: true
            integration_name: gateway-manager
            schema:
              type: json_schema
              definition:
                type: object
                required:
                  - threshold
                  - relative_window
                properties:
                  threshold:
                    type: number
                    maximum: 100
                    minimum: 0
                  relative_window:
                    enum:
                      - 15m
                      - 1h
                      - 6h
                      - 12h
                      - 24h
                      - 7d
                      - current_week
                      - previous_week
                      - 30d
                      - current_month
                      - previous_month
                    type: string
            required_integration_capability: null
          - name: on_call_engineer_assigned
            display_name: On Call Engineer Assigned
            category: Incident Management
            template_string: Has an on call engineer assigned to the service
            installed: true
            integration_name: null
            schema: null
            required_integration_capability: on_call_provider
        meta:
          page:
            total: 2
            size: 100
            number: 1
    UnauthorizedExample:
      value:
        status: 401
        title: Unauthorized
        instance: kong:trace:8347343766220159418
        detail: Unauthorized
    ForbiddenExample:
      value:
        status: 403
        title: Forbidden
        instance: kong:trace:2723154947768991354
        detail: You do not have permission to perform this action
  securitySchemes:
    konnectAccessToken:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >
        The Konnect access token is meant to be used by the Konnect dashboard
        and the decK CLI authenticate with.
    personalAccessToken:
      type: http
      scheme: bearer
      bearerFormat: Token
      description: >
        The personal access token is meant to be used as an alternative to
        basic-auth when accessing Konnect via APIs.

        You can generate a Personal Access Token (PAT) from the [personal access
        token page](https://cloud.konghq.com/global/account/tokens/) in the
        Konnect dashboard.

        The PAT token must be passed in the header of a request, for example:

        `curl -X GET 'https://global.api.konghq.com/v2/users/' --header
        'Authorization: Bearer kpat_xgfT...'`
    systemAccountAccessToken:
      type: http
      scheme: bearer
      bearerFormat: Token
      description: >
        The system account access token is meant for automations and
        integrations that are not directly associated with a human identity.

        You can generate a system account Access Token by creating a system
        account and then obtaining a system account access token for that
        account.

        The access token must be passed in the header of a request, for example:

        `curl -X GET 'https://global.api.konghq.com/v2/users/' --header
        'Authorization: Bearer spat_i2Ej...'`
```