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

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

# List Scorecard Templates

`GET` `/scorecard-templates`

Operation ID: `list-scorecard-templates`

Returns a paginated collection of scorecard templates.

## Query parameters

- `filter` (object, optional) - Filters a collection of scorecard templates.
- `sort` (optional) - Sorts a collection of scorecard 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 scorecard 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:
  /scorecard-templates:
    get:
      x-unstable: true
      x-internal: true
      summary: List Scorecard Templates
      operationId: list-scorecard-templates
      description: Returns a paginated collection of scorecard templates.
      parameters:
        - $ref: "#/components/parameters/ScorecardTemplateFilter"
        - $ref: "#/components/parameters/ScorecardTemplateSort"
      responses:
        "200":
          $ref: "#/components/responses/ListScorecardTemplatesResponse"
      tags:
        - Scorecards
security:
  - konnectAccessToken: []
  - personalAccessToken: []
  - systemAccountAccessToken: []
components:
  parameters:
    ScorecardTemplateFilter:
      name: filter
      description: Filters a collection of scorecard templates.
      required: false
      in: query
      style: deepObject
      schema:
        $ref: "#/components/schemas/ScorecardTemplateFilterParameters"
    ScorecardTemplateSort:
      name: sort
      description: >
        Sorts a collection of scorecard templates. Supported sort attributes
        are:
          - `display_name`
          - `name`

        Default sort is `display_name` in ascending order.
      required: false
      in: query
      schema: {}
  responses:
    ListScorecardTemplatesResponse:
      description: A paginated list response for a collection of scorecard templates.
      content:
        application/json:
          schema:
            type: object
            additionalProperties: false
            properties:
              meta: {}
              data:
                type: array
                items:
                  $ref: "#/components/schemas/ScorecardTemplate"
            required:
              - meta
              - data
  schemas:
    ScorecardTemplateFilterParameters:
      type: object
      properties: {}
    ScorecardTemplate:
      type: object
      description: Representation of a scorecard template.
      required:
        - name
        - display_name
        - description
        - criteria
      properties:
        name:
          $ref: "#/components/schemas/ScorecardTemplateName"
        display_name:
          type: string
          example: Kong Best Practices
        description:
          type: string
          example: Best practices that we encourage users to follow when using other
            Konnect applications.
        criteria:
          type: array
          items:
            $ref: "#/components/schemas/ScorecardTemplateCriteria"
          example:
            - template_name: gateway_manager_error_rate
              template_parameters:
                relative_window: 30d
              integration: gateway_manager
            - template_name: gateway_manager_response_latency
              template_parameters:
                metric: response_latency_p95
                relative_window: 30d
              integration: gateway_manager
            - template_name: gateway_manager_has_plugin
              template_parameters: {}
              integration: gateway_manager
    ScorecardTemplateName:
      type: string
      description: Well-known name of the template. Uniquely identifies the template.
      enum:
        - kong_best_practices
        - service_documentation
        - service_maturity
        - security_and_compliance
      example: kong_best_practices
    ScorecardTemplateCriteria:
      type: object
      required:
        - integration
        - template_name
        - template_parameters
      properties:
        integration:
          type: string
          nullable: true
          description: The integration `name` when it provides the criteria template.
            Otherwise `null`.
          example: null
        template_name:
          type: string
          description: Reference to the unique `name` of the criteria template.
          example: time_to_merge
        template_parameters:
          $ref: "#/components/schemas/CriteriaParameters"
    CriteriaParameters:
      type: object
      description: Input parameters for the given criteria template.
      nullable: true
      additionalProperties: true
      example:
        measure: median
        threshold:
          unit: hours
          value: 6
        window:
          unit: months
          value: 3
```