---
title: "List Resource Mappings"
url: "https://dev-portal.dehaven.org/apis/konnect-service-catalog-1-2-0/versions/5f6559bf-d7ba-429c-95c4-cbf2371e663f/operations/list-resource-mappings"
---

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

# List Resource Mappings

`GET` `/resource-mappings`

Operation ID: `list-resource-mappings`

Returns a paginated collection of catalog resource mappings.

## Query parameters

- `filter` (object, optional) - Filters a collection of resource mappings.
- `sort` (optional) - Sorts a collection of resource mappings. Supported sort attributes are: - `created_at` Default sort is `created_at` in descending order.

## Responses

- `200` - A paginated list response for a collection of catalog resource mappings.

## 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:
  /resource-mappings:
    get:
      x-unstable: true
      x-internal: true
      summary: List Resource Mappings
      description: Returns a paginated collection of catalog resource mappings.
      operationId: list-resource-mappings
      parameters:
        - $ref: "#/components/parameters/CatalogResourceMappingFilter"
        - $ref: "#/components/parameters/CatalogResourceMappingSort"
      responses:
        "200":
          $ref: "#/components/responses/ListCatalogResourceMappingsResponse"
      tags:
        - Resource Mappings
security:
  - konnectAccessToken: []
  - personalAccessToken: []
  - systemAccountAccessToken: []
components:
  parameters:
    CatalogResourceMappingFilter:
      name: filter
      description: Filters a collection of resource mappings.
      required: false
      in: query
      style: deepObject
      schema:
        $ref: "#/components/schemas/CatalogResourceMappingFilterParameters"
    CatalogResourceMappingSort:
      name: sort
      description: |
        Sorts a collection of resource mappings. Supported sort attributes are:
          - `created_at`

        Default sort is `created_at` in descending order.
      required: false
      in: query
      schema: {}
  responses:
    ListCatalogResourceMappingsResponse:
      description: A paginated list response for a collection of catalog resource mappings.
      content:
        application/json:
          schema:
            type: object
            additionalProperties: false
            properties:
              meta: {}
              data:
                type: array
                items:
                  $ref: "#/components/schemas/CatalogResourceMapping"
            required:
              - meta
              - data
  schemas:
    CatalogResourceMappingFilterParameters:
      type: object
      properties: {}
    CatalogResourceMapping:
      description: Describes a mapping between a catalog resource and a service.
      type: object
      required:
        - id
        - resource
        - service
        - created_at
      properties:
        id:
          type: string
          format: uuid
          example: d277faad-ed4e-4c56-a0fb-acce065dee34
          description: The resource mapping ID.
        resource:
          $ref: "#/components/schemas/CatalogResourceRef"
        service:
          $ref: "#/components/schemas/CatalogServiceRef"
    CatalogResourceRef:
      type: object
      description: Short-hand descriptor of a catalog resource.
      required:
        - id
        - name
        - type
        - config
        - integration
      properties:
        id:
          $ref: "#/components/schemas/CatalogResourceId"
        name:
          type: string
          nullable: true
          description: The name of the resource.
        integration:
          $ref: "#/components/schemas/IntegrationRef"
        type:
          $ref: "#/components/schemas/CatalogResourceType"
        config:
          $ref: "#/components/schemas/CatalogResourceConfig"
    CatalogServiceRef:
      type: object
      description: Short-hand descriptor of a catalog service.
      required:
        - id
        - name
        - display_name
      properties:
        id:
          type: string
          format: uuid
          example: 7f9fd312-a987-4628-b4c5-bb4f4fddd5f7
          description: The service ID.
        name:
          type: string
          description: >
            The machine name of the service that uniquely identifies it within
            the catalog.
          example: user-svc
        display_name:
          type: string
          description: The display name of the service.
          example: User Service
    CatalogResourceId:
      type: string
      format: base64url
      example: 4UdXnoaDYYJsH_Ir
      description: The resource ID.
      minLength: 16
      maxLength: 16
    IntegrationRef:
      x-flatten-allOf: true
      title: IntegrationRef
      allOf:
        - $ref: "#/components/schemas/IntegrationRefWithoutInstance"
        - type: object
          description: Short-hand descriptor of an integration installed within the catalog.
          required:
            - instance
          properties:
            instance:
              $ref: "#/components/schemas/IntegrationInstanceRef"
    CatalogResourceType:
      type: string
      description: >
        The resource type. Available resource types are compiled from the
        integrations installed within the catalog.
      minLength: 1
      maxLength: 120
      example: gateway_svc
    CatalogResourceConfig:
      type: object
      description: >
        JSON object representing the properties used to identify the resource in
        the third-party system.

        The schema depends on the resource type and is dynamically registered at
        runtime.
      additionalProperties: true
      example:
        control_plane_id: ccadfb0a-56cd-4f74-955d-aec1d87157c8
        gateway_service_id: 94896d05-0c4d-45eb-aae3-de754885dd58
    IntegrationRefWithoutInstance:
      type: object
      description: Short-hand descriptor of an integration that omits instance metadata.
      required:
        - name
        - display_name
      properties:
        name:
          type: string
          example: gateway-manager
        display_name:
          type: string
          example: gateway-manager
    IntegrationInstanceRef:
      type: object
      description: Short-hand descriptor of an integration instance.
      required:
        - id
        - name
        - display_name
      properties:
        id:
          type: string
          format: uuid
          example: 772b9caf-ddbc-4f4f-8aa4-8dfbbe420351
          description: The integration instance ID.
        name:
          type: string
          description: >
            The machine name of the integration instance that uniquely
            identifies it within the catalog.
          pattern: ^[0-9a-z.-]+$
          example: aws-lambda-prod
        display_name:
          type: string
          description: The display name of the integration instance.
          example: AWS (prod)
```