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

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

# List Scorecard Services

`GET` `/scorecards/{id}/services`

Operation ID: `list-scorecard-services`

Lists services targeted by a scorecard.

## Path parameters

- `id` (string, uuid, required) - The `id` of the scorecard.

## Query parameters

- `filter` (optional) - Filters a collection of services targeted by a scorecard.
- `sort` (optional) - Sorts a collection of services targeted by a scorecard. Supported sort attributes are: - `display_name` - `name` - `score.value` - `score.raw_value` Default sort is `display_name` in ascending order.

## Responses

- `200` - A paginated list response for a collection of services targeted by a scorecard.

## 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:
  /scorecards/{id}/services:
    parameters:
      - schema:
          type: string
          format: uuid
          example: f3704e4c-104d-4f21-998a-20d4364c893f
        name: id
        in: path
        required: true
        description: The `id` of the scorecard.
    get:
      x-unstable: true
      x-internal: true
      summary: List Scorecard Services
      description: Lists services targeted by a scorecard.
      operationId: list-scorecard-services
      parameters:
        - $ref: "#/components/parameters/ScorecardServiceFilter"
        - $ref: "#/components/parameters/ScorecardServiceSort"
      responses:
        "200":
          $ref: "#/components/responses/ListScorecardServicesResponse"
      tags:
        - Scorecards
security:
  - konnectAccessToken: []
  - personalAccessToken: []
  - systemAccountAccessToken: []
components:
  parameters:
    ScorecardServiceFilter:
      name: filter
      description: Filters a collection of services targeted by a scorecard.
      required: false
      in: query
      style: deepObject
      schema:
        $ref: "#/components/schemas/ScorecardServiceFilterParameters"
    ScorecardServiceSort:
      name: sort
      description: >
        Sorts a collection of services targeted by a scorecard. Supported sort
        attributes are:
          - `display_name`
          - `name`
          - `score.value`
          - `score.raw_value`

        Default sort is `display_name` in ascending order.
      required: false
      in: query
      schema: {}
  responses:
    ListScorecardServicesResponse:
      description: A paginated list response for a collection of services targeted by
        a scorecard.
      content:
        application/json:
          schema:
            type: object
            additionalProperties: false
            properties:
              meta: {}
              data:
                type: array
                items:
                  $ref: "#/components/schemas/ScorecardService"
            required:
              - meta
              - data
  schemas:
    ScorecardServiceFilterParameters:
      x-flatten-allOf: true
      allOf:
        - $ref: "#/components/schemas/CatalogServiceFilterParameters"
        - type: object
          properties: {}
    ScorecardService:
      x-flatten-allOf: true
      allOf:
        - $ref: "#/components/schemas/CatalogService"
        - title: ScorecardService
          description: Service object that includes its score for the given scorecard.
          type: object
          required:
            - score
          properties:
            score:
              $ref: "#/components/schemas/ScorecardScore"
    CatalogServiceFilterParameters:
      type: object
      properties:
        id: {}
        name: {}
        display_name: {}
        custom_fields:
          description: >
            Filter by custom fields using dot-notation to specify the custom
            field.

            Filter operators are dictated by the custom field type. For example:
              - `filter[custom_fields.owner]`
              - `filter[custom_fields.owner][neq]=kong`
              - `filter[custom_fields.dashboard.link][contains]=https`
          oneOf: []
        labels: {}
    CatalogService:
      title: CatalogService
      description: The service object contains information about a Service Catalog service.
      type: object
      required:
        - id
        - name
        - display_name
        - description
        - custom_fields
        - labels
        - created_at
        - updated_at
      properties:
        id:
          type: string
          format: uuid
          example: 7f9fd312-a987-4628-b4c5-bb4f4fddd5f7
          description: The service ID.
          readOnly: true
        name:
          type: string
          description: >
            The machine name of the Service that uniquely identifies it within
            the catalog.
          minLength: 1
          maxLength: 120
          pattern: ^[0-9a-z.-]+$
          example: user-svc
        display_name:
          type: string
          description: The display name of the Service.
          minLength: 1
          maxLength: 120
          example: User Service
        description:
          type: string
          description: Optionally provide a description of the Service.
          nullable: true
          maxLength: 2048
        custom_fields:
          $ref: "#/components/schemas/CustomFields"
        labels: {}
    ScorecardScore:
      type: object
      description: >
        The current score for the given Scorecard.

        A `null` value indicates the scorecard has not yet been evaluated and
        therefore no score has been computed.
      nullable: true
      required:
        - value
        - raw_value
      properties:
        value:
          type: string
          description: The human-readable score value coverted to the Scorecard's assigned
            grading system.
          example: 88%
        raw_value:
          type: number
          description: >
            The raw, numeric score calculated during evaluation of the
            scorecard.

            Rounded to 3 decimal places.
          minimum: 0
          maximum: 100
          example: 87.5
    CustomFields:
      type: object
      description: >
        Map of customizable, catalog-defined fields providing information about
        a service.
      additionalProperties:
        oneOf:
          - $ref: "#/components/schemas/TextCustomField"
          - $ref: "#/components/schemas/NumericCustomField"
          - $ref: "#/components/schemas/BooleanCustomField"
          - $ref: "#/components/schemas/UrlCustomField"
      example:
        owner: John Appleseed
        dashboard:
          name: On-Call Dashboard
          link: https://my-dashboard-svc.io/dashboards/1
    TextCustomField:
      type: string
      nullable: true
    NumericCustomField:
      type: number
      nullable: true
    BooleanCustomField:
      type: boolean
      nullable: true
    UrlCustomField:
      type: object
      nullable: true
      required:
        - name
        - link
      properties:
        name:
          description: The human-readable name of the URL link.
          type: string
          example: On-Call Dashboard
        link:
          description: The href value of the URL link.
          type: string
          format: uri-reference
          example: https://my-dashboard-svc.io/dashboards/1
```