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

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

# List Integrations

`GET` `/integrations`

Operation ID: `list-catalog-integrations`

Returns a paginated collection of all catalog integrations available to connect. Each integration represents a built-in connector that extends the platform's capabilities; enabling discovery, resource management, event ingestion, and more. Integrations expose metadata that describes how they authenticate, what configuration they require, and how they interact with catalog entities like Resources and Services. Currently, integrations are platform-defined and cannot be extend or registered by customers.

## Query parameters

- `filter` (object, optional) - Filters a collection of integrations.
- `sort` (optional) - Sorts a collection of integrations. 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 integrations.

## 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:
  /integrations:
    get:
      x-unstable: true
      x-internal: true
      parameters:
        - $ref: "#/components/parameters/CatalogIntegrationFilter"
        - $ref: "#/components/parameters/CatalogIntegrationSort"
      summary: List Integrations
      description: >
        Returns a paginated collection of all catalog integrations available to
        connect.

        Each integration represents a built-in connector that extends the
        platform's capabilities;

        enabling discovery, resource management, event ingestion, and more.

        Integrations expose metadata that describes how they authenticate, what
        configuration they

        require, and how they interact with catalog entities like Resources and
        Services.


        Currently, integrations are platform-defined and cannot be extend or
        registered by customers.
      operationId: list-catalog-integrations
      responses:
        "200":
          $ref: "#/components/responses/ListCatalogIntegrationsResponse"
      tags:
        - Integrations
security:
  - konnectAccessToken: []
  - personalAccessToken: []
  - systemAccountAccessToken: []
components:
  parameters:
    CatalogIntegrationFilter:
      name: filter
      description: Filters a collection of integrations.
      required: false
      in: query
      style: deepObject
      schema:
        $ref: "#/components/schemas/CatalogIntegrationFilterParameters"
    CatalogIntegrationSort:
      name: sort
      description: |
        Sorts a collection of integrations. Supported sort attributes are:
          - `display_name`
          - `name`

        Default sort is `display_name` in ascending order.
      required: false
      in: query
      schema: {}
  responses:
    ListCatalogIntegrationsResponse:
      description: A paginated list response for a collection of integrations.
      content:
        application/json:
          schema:
            type: object
            additionalProperties: false
            properties:
              meta: {}
              data:
                type: array
                items:
                  $ref: "#/components/schemas/CatalogIntegration"
            required:
              - meta
              - data
  schemas:
    CatalogIntegrationFilterParameters:
      type: object
      properties:
        name: {}
    CatalogIntegration:
      type: object
      required:
        - built_in
        - name
        - display_name
        - version
        - authorization
        - config_schema
        - resource_types
        - discovery
        - api_spec_provider
        - events
      properties:
        name:
          type: string
          description: The machine name of the integration that uniquely identifies it
            within the catalog.
          example: gateway-manager
          readOnly: true
        display_name:
          type: string
          description: The display name of the integration.
          example: Gateway Manager
          readOnly: true
        description:
          type: string
          description: The description of the integration.
          readOnly: true
        built_in:
          type: boolean
          description: |
            Denotes whether the integration is built-in to the catalog.
            Built-in integrations are always connected and available by default.
          example: true
          readOnly: true
        version:
          type: string
          description: The integration version.
          example: v1
          readOnly: true
        authorization:
          $ref: "#/components/schemas/CatalogIntegrationAuthorization"
        config_schema:
          $ref: "#/components/schemas/CatalogIntegrationConfigSchema"
        resource_types:
          $ref: "#/components/schemas/CatalogIntegrationResourceTypes"
        discovery:
          $ref: "#/components/schemas/CatalogIntegrationDiscovery"
        api_spec_provider:
          $ref: "#/components/schemas/CatalogIntegrationApiSpecProvider"
        events:
          $ref: "#/components/schemas/CatalogIntegrationEvents"
    CatalogIntegrationAuthorization:
      x-flatten-allOf: true
      allOf:
        - oneOf:
            - nullable: true
            - $ref: "#/components/schemas/OAuth"
            - $ref: "#/components/schemas/MultiKeyAuth"
            - $ref: "#/components/schemas/GitHubAppInstallationAuth"
        - title: CatalogIntegrationAuthorization
          description: Defines the authorization strategy for an integration.
    CatalogIntegrationConfigSchema:
      description: Defines the configuration schema for the integration.
      additionalProperties:
        oneOf:
          - nullable: true
          - $ref: "#/components/schemas/StringConfigFieldSchema"
          - $ref: "#/components/schemas/EnumConfigFieldSchema"
          - $ref: "#/components/schemas/BooleanConfigFieldSchema"
      example:
        base_url:
          type: string
          display_name: Base URL
          description: The customer-specific API URL
          required: true
    CatalogIntegrationResourceTypes:
      type: object
      description: >
        Defines the resource types that the integration manages within the
        catalog.


        This schema is a key-value object where:
          - Keys are globally unique, machine-readable identifiers for each resource type.
          - Values are objects describing metadata about the resource type.

        This declaration enables the platform to understand the structure,
        identity, and behavior of resources discovered by the integration.

        By registering resource types, integrations communicate the kinds of
        entities they will ingest and maintain, 

        allowing the catalog to enforce consistency, validation, and visibility
        across all integrations.
      additionalProperties:
        type: object
        title: ResourceType
        required:
          - schema
        properties:
          display_name:
            type: string
            description: The user-friendly resource type name.
          schema:
            $ref: "#/components/schemas/SimpleSchema"
      example:
        gateway_svc:
          display_name: Gateway Service
          schema:
            type: simple
            definition:
              control_plane_id: string
              gatway_service_id: string
        analytics_dashboard:
          display_name: Dashboard
          schema:
            type: simple
            definition:
              dashboard_id: string
    CatalogIntegrationDiscovery:
      type: object
      description: >
        Defines how the integration participates in Discovery.

        Discovery enables integrations to automatically ingest and update
        resources in the catalog.
      nullable: true
      required:
        - resource_attribute_examples
      properties:
        resource_attribute_examples:
          description: >
            A map of example resource `attributes` payloads by resource type.

              - Keys are the machine-readable, globally unique names of resource types registered by this integration.
              - Values are example `attributes` payloads.
          type: object
          additionalProperties:
            type: object
            additionalProperties: true
            description: An example `attributes` payload for the given resource type.
          example:
            gateway_service:
              control_plane:
                id: 00000000-0000-0000-0000-000000000000
                name: dev-ext
                labels:
                  env: development
              gateway_service:
                id: 11111111-1111-1111-1111-111111111111
                name: gateway-service
                host: konghq.com
                path: /example
                type: service
                port: 443
                protocol: https
                enabled: true
    CatalogIntegrationApiSpecProvider:
      description: >
        Defines how an integration behaves as a source provider of Catalog
        Service API specs.

        API specs are entities that can be attached to Catalog Services.

        When an integration implements this capability, it can act as a source
        type for API spec contents.

        In this role, the integration becomes the source of truth for the spec.

        When a spec is attached to a Catalog Service using this source type, the
        platform relies on the external system to provide and update the spec
        data.

        A null value indicates the given integration does not act as a source
        provider of API specs.
      type: object
      nullable: true
      required:
        - name
        - display_name
        - description
        - config_schema
        - resource_type
      properties:
        name:
          type: string
          example: konnect_api
          description: >
            The globally unique name of the API spec provider that identifies it
            within the catalog.

            Corresponds to the API spec provider `type` when creating API specs.
        display_name:
          type: string
          example: Konnect API
          description: A user-friendly name for the API spec provider.
        description:
          type: string
          description: An brief description of the API spec provider.
        config_schema:
          x-flatten-allOf: true
          allOf:
            - $ref: "#/components/schemas/SimpleSchema"
            - description: Defines the shape of the API spec provider config.
              example:
                type: simple
                definition:
                  api_id: string
        resource_type:
          type: string
          nullable: true
          description: >
            When non-null, denotes that the API spec provider is bound to the
            given Resource type.

            This means that API specs are auto-created when a Resource of the
            given type is mapped to a service.

            Furthermore, it couples the lifecycle of the API Spec with the given
            Resource mapping.

            When the given Resource is removed, the API spec will be deleted.
    CatalogIntegrationEvents:
      description: >
        Defines the event types across all resource types belonging to the
        integration that will be ingested into the catalog.

          - Keys are the machine-readable, globally unique names of resource types registered by this integration.
          - Values are a map of event type definitions.
      type: object
      nullable: true
      additionalProperties:
        $ref: "#/components/schemas/IntegrationResourceEvents"
      example:
        gateway_svc:
          plugin_added:
            display_name: Plugin Added
            description: Event triggered when a new plugin is added to a gateway service.
            events_feed:
              enabled: true
    OAuth:
      type: object
      description: >
        Defines the OAuth 2.0 authorization strategy used by an integration.

        This schema provides all necessary information for the platform to
        initiate

        and manage OAuth-based authorization flows on behalf of customers.
      required:
        - type
        - config
      properties:
        type:
          type: string
          enum:
            - oauth
        overridable_config:
          description: >
            A list of field names from the `config` object (e.g., `client_id`,
            `authorization_endpoint`, etc)

            that can be overridden on a per-customer basis. When a field is
            listed here, the catalog allows

            customer-defined values to take precedence over the default
            configuration provided by the integration.

            This supports flexible deployment models, including both SaaS-based
            and self-hosted OAuth authorization flows. 
          type: array
          items:
            type: string
            enum:
              - client_id
              - client_secret
              - authorization_endpoint
              - token_endpoint
        config:
          type: object
          required:
            - grant_type
            - client_id
            - authorization_endpoint
            - token_endpoint
            - scope
            - rolling_refresh_exp_seconds
          properties:
            grant_type:
              type: string
              enum:
                - authorization_code
              description: >
                The OAuth 2.0 grant type used for authorization (e.g.,
                `authorization_code`).

                Determines the flow the integration uses to request access
                tokens.
            client_id:
              type: string
              example: d745213a-b7e8-4998-abe3-41f164001970
              description: The OAuth client identifier registered with the integration
                provider.
            authorization_endpoint:
              type: object
              required:
                - url
              properties:
                url:
                  type: string
                  format: uri
                  example: https://identity.service.com/oauth/authorize
                  description: The URL where users are redirected to authorize access.
            token_endpoint:
              type: object
              required:
                - url
              properties:
                url:
                  type: string
                  format: uri
                  example: https://identity.service.com/oauth/token
                  description: The URL used to retrieve access tokens.
            scope:
              type: array
              items:
                type: string
              example:
                - read
                - write
              description: |
                A list of permission scopes requested by the integration. 
                Defines what level of access the token will grant.
            rolling_refresh_exp_seconds:
              type: number
              nullable: true
              description: >
                Number of seconds before the refresh token grant can no longer
                be used to mint

                a new access token. Once expired clients must re-authenticate to
                restart the

                window interval.
              example: 15780000
    MultiKeyAuth:
      type: object
      description: >
        Defines an authentication strategy based on one or more API keys passed
        via HTTP headers. 

        This strategy supports integrations that require custom headers for
        credential-based access, 

        allowing flexibility across providers with different authentication
        header requirements.
      required:
        - type
        - config
      properties:
        type:
          type: string
          enum:
            - multi_key_auth
        config:
          type: object
          required:
            - headers
          properties:
            headers:
              type: array
              minItems: 1
              description: >
                A list of header definitions used to transmit API credentials to
                the integration's external API. 

                Each header represents a unique key required by the provider.
              items:
                type: object
                title: KeyAuthHeader
                required:
                  - name
                  - display_name
                  - description
                properties:
                  name:
                    description: The exact name of the HTTP request header where the credential
                      should be inserted.
                    type: string
                    example: X-API-Key
                  display_name:
                    description: An optional user-friendly label for the key, used in UI forms to
                      guide users.
                    type: string
                    example: API Key
                    nullable: true
                  description:
                    description: An optional brief explanation of the purpose or usage of the key.
                    type: string
                    nullable: true
    GitHubAppInstallationAuth:
      type: object
      description: >
        Defines the GitHub App authorization strategy used by the GitHub
        integration.

        This strategy enables secure access to GitHub APIs using app
        installation tokens.

        It supports both API-based interactions and real-time event delivery via
        GitHub webhooks.

        Unlike standard OAuth flows, this strategy leverages GitHub's custom app
        installation flow

        and token lifecycle, making it ideal for deep, organization-level GitHub
        integration.
      required:
        - type
        - config
      properties:
        type:
          type: string
          enum:
            - github_app_installation
        config:
          type: object
          required:
            - app_install_url
            - app_manage_url
            - authorize_app_installation_endpoint
            - pending_app_installs_endpoint
          properties:
            app_install_url:
              type: object
              additionalProperties: false
              required:
                - url
              properties:
                url:
                  type: string
                  format: uri
                  example: https://global.api.konghq.com/service-catalog-integrations/github/app/install
                  description: >
                    The URL where customers are directed to install the GitHub
                    App into their

                    GitHub organization.
            app_manage_url:
              type: object
              additionalProperties: false
              required:
                - url
              properties:
                url:
                  type: string
                  format: uri
                  example: https://global.api.konghq.com/service-catalog-integrations/github/app/manage
                  description: The GitHub App management page URL where users can view, configure,
                    or uninstall the app after installation.
            authorize_app_installation_endpoint:
              type: object
              additionalProperties: false
              required:
                - url
              properties:
                url:
                  type: string
                  format: uri
                  example: https://global.api.konghq.com/service-catalog-integrations/github/app/authorize-installation
                  description: >
                    The endpoint used to link a completed GitHub App
                    installation with a customer account in the catalog.

                    This step finalizes the integration by exchanging metadata
                    from the GitHub installation event.
            pending_app_installs_endpoint:
              type: object
              additionalProperties: false
              required:
                - url
              properties:
                url:
                  type: string
                  format: uri
                  example: https://global.api.konghq.com/service-catalog-integrations/github/app/pending-installs
                  description: >
                    The endpoint used to return a list of in-progress or
                    unlinked GitHub App installations awaiting user
                    confirmation.
    StringConfigFieldSchema:
      x-flatten-allOf: true
      allOf:
        - $ref: "#/components/schemas/BaseConfigFieldSchema"
        - title: StringConfigFieldSchema
          description: Defines a string value integration config field.
          type: object
          required:
            - type
          properties:
            type:
              type: string
              description: The field type of the config value.
              enum:
                - string
            default:
              type: string
              description: The default value for the config field.
    EnumConfigFieldSchema:
      x-flatten-allOf: true
      allOf:
        - $ref: "#/components/schemas/BaseConfigFieldSchema"
        - type: object
          title: EnumConfigFieldSchema
          description: Defines an enum value integration config field.
          required:
            - type
            - choices
          properties:
            type:
              type: string
              description: The field type of config value.
              enum:
                - enum
            choices:
              type: array
              description: List of enumerated choices that can be selected as the config field
                value.
              items:
                type: object
                required:
                  - value
                  - display_name
                properties:
                  value:
                    type: string
                    description: The value represented by this option.
                  display_name:
                    type: string
                    description: user-friendly name of the option.
                  description:
                    type: string
                    description: Optional brief description of the option.
            default:
              type: string
              description: |
                The default value for the config field.
                Must reference the value of an option listed in `choices`.
    BooleanConfigFieldSchema:
      x-flatten-allOf: true
      allOf:
        - $ref: "#/components/schemas/BaseConfigFieldSchema"
        - title: BooleanConfigFieldSchema
          description: Defines a boolean value integration config field.
          type: object
          required:
            - type
          properties:
            type:
              type: string
              description: The field type of the config value.
              enum:
                - boolean
            default:
              type: boolean
              description: The default value for the config field.
    SimpleSchema:
      type: object
      required:
        - type
        - definition
      properties:
        type:
          type: string
          enum:
            - simple
        definition:
          type: object
          additionalProperties:
            type: string
            enum:
              - string
              - number
              - boolean
    IntegrationResourceEvents:
      description: >
        Defines the event types for a given resource type belonging to the
        integration that will be ingested in the catalog.

          - Keys are the machine-readable, globally unique names of resource types registered by this integration.
          - Values are the event type definition.
      type: object
      additionalProperties:
        $ref: "#/components/schemas/IntegrationResourceEvent"
    BaseConfigFieldSchema:
      type: object
      properties:
        display_name:
          type: string
          description: user-friendly name of the configuration field.
        description:
          type: string
          description: Optional brief description of the configuration field.
        required:
          type: boolean
          description: Denotes whether the config field is a required value.
          default: false
        mutable_condition:
          $ref: "#/components/schemas/MutableCondition"
    IntegrationResourceEvent:
      description: Defines a registered event type for a given resource.
      type: object
      required:
        - display_name
        - description
        - events_feed
      properties:
        display_name:
          type: string
          description: User-friendly display name for the event type.
        description:
          type: string
          description: Optional, brief description of the integration event type.
          nullable: true
        events_feed:
          type: object
          required:
            - enabled
          properties:
            enabled:
              type: boolean
              description: Whether this event type is returned by default in the Events API.
    MutableCondition:
      description: >
        Defines the condition under which this configuration field is allowed to
        be modified.

        When specified, the platform will restrict updates to this field unless
        the integration

        meets the given condition.


        For example, setting `mutable_condition: unauthorized` means the field
        can only be 

        changed while the integration is in an unauthorized state.
      type: string
      enum:
        - unauthorized
```