--- title: "List Scorecards" method: GET path: "/v1/scorecards" tags: ["Scorecards"] --- # List Scorecards `GET /v1/scorecards` Returns a paginated collection of scorecards. ## Query parameters - `page[size]` integer - `page[number]` integer - `filter` ScorecardFilterParameters - `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. - `score.value` 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. - `score.raw_value` union — Filter by a numeric value. - number — Value strictly equals the given numeric value. - object - `eq` number, required — Value strictly equals the given numeric value. - object - `lt` number, required — Value is less than the given numeric value. - object - `lte` number, required — Value is less than or equal to the given numeric value. - object - `gt` number, required — Value is greater than the given numeric value. - object - `gte` number, required — Value is greater than or equal to the given numeric 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 scorecards. - 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` Scorecard[], required - `id` string, uuid, required - `name` string, required — The human-readable name of the scorecard. - `description` string, nullable, required - `score` ScorecardScore, nullable, required — 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. - `value` string, required — The human-readable score value coverted to the Scorecard's assigned grading system. - `raw_value` number, required — The raw, numeric score calculated during evaluation of the scorecard. Rounded to 3 decimal places. - `entity_selector` union, required — Selector used to dynamically target catalog entities that will be included in the given scorecard's evaluated score. - AllEntitiesSelector — Entity selector that includes all entities of the given type within the catalog. - `selector` 'all', required - `selector_parameters` 'null', nullable, required - ByIDsSelector — Entity selector that includes entities contained within a list of IDs. - `selector` 'ids', required - `selector_parameters` object, required - `ids` string[], required - ByNameSelector — Entity selector that includes entities by `name`. - `selector` 'name', required - `selector_parameters` StringFieldSelectorParams, required - `operator` 'eq' | 'contains', required - `value` string, required - ByDisplayNameSelector — Entity selector that includes entities by `display_name`. - `selector` 'display_name', required - `selector_parameters` StringFieldSelectorParams, required - `operator` 'eq' | 'contains', required - `value` string, required - ByCustomFieldSelector — Entity selector that include entities by a custom field. - `selector` 'custom_field', required - `selector_parameters` union, required - object - `field` string, required — Name of the custom field. - `value` string, required - `operator` 'eq' | 'contains', required - object - `field` string, required — Name of the custom field. - `value` number, required - `operator` 'eq' | 'lt' | 'gt', required - object - `field` string, required — Name of the custom field. - `value` boolean, required - `operator` 'eq', required - object - `field` string, required — Name of the custom field. - `subfield` 'name' | 'link', required — Specify which subfield of the `url` custom field value to use for selection. - `value` string, required - `operator` 'eq' | 'contains', required - ByLabelSelector — Entity selector that includes entities by `label` value. - `selector` 'label', required - `selector_parameters` object, required - `operator` 'eq' | 'contains', required - `value` string, required - `label_key` string, required - HasLabelKeySelector — Entity selector that includes entities by inclusion of a `label` key. - `selector` 'has_label_key', required - `selector_parameters` object, required - `label_key` string, required - HasDocsSelector — Entity selector to include entities by attached documentation. - `selector` 'has_docs', required - `selector_parameters` 'null', nullable, required - HasApisSelector — Entity selector that includes services by attached APIs. - `selector` 'api_count', required - `selector_parameters` HasSelectorParams, required - `operator` 'eq' | 'gte' | 'lte', required - `value` number, required - HasResourcesSelector — Entity selector that includes services by mapped resources. - `selector` 'resource_count', required - `selector_parameters` object, required - `operator` 'eq' | 'gte' | 'lte', required - `value` number, required - `resource_type` string, required — The resource type. Available resource types are compiled from the integrations installed within the catalog. - `integration` string, required — The machine name of the integration that uniquely identifies it within the catalog. - `scorecard_template` 'kong_best_practices' | 'service_documentation' | 'service_maturity' | 'security_and_compliance', nullable, required — The name of the scorecard template used to create the scorecard. Otherwise, `null`. - `created_at` string, date-time, required — An ISO-8601 timestamp representation of entity creation date. - `updated_at` string, date-time, required — An ISO-8601 timestamp representation of entity update date. ## 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/versions/0261aef4b1e2/schema)