---
title: "List API Implementations"
url: "https://nov18-dev.movespot.fyi/apis/konnect-api-catalog-3/versions/b74d7c76-ffb8-4e47-b70c-11184b8918a6/operations/list-api-implementations"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/konnect-api-catalog-3/versions/b74d7c76-ffb8-4e47-b70c-11184b8918a6.md

# List API Implementations

`GET` `/api-implementations`

Operation ID: `list-api-implementations`

List gateway implementations for this API

## Query parameters

- `page[size]` (integer, optional) - The maximum number of items to include per page. The last page of a collection may include fewer items.
- `page[number]` (integer, optional) - Determines which page of the entities to retrieve.
- `filter` (object, optional) - Filters APIs in the response.
- `sort` (string, optional) - Sorts a collection of API implementations. Supported sort attributes are: - id - api_id - control_plane_id - service_id - created_at - updated_at

## Responses

- `200` - Paginated list of API implementations
- `401` - ApiUnauthorized
- `403` - ApiForbidden
- `404` - Not Found

## OpenAPI definition

```yaml
openapi: 3.0.3
info:
  title: Konnect API Catalog
  version: 3.1.1
servers:
  - url: https://us.api.konghq.com/v3
    description: United-States Production region
  - url: https://eu.api.konghq.com/v3
    description: Europe Production region
  - url: https://au.api.konghq.com/v3
    description: Australia Production region
  - url: https://me.api.konghq.com/v3
    description: Middle-East Production region
  - url: https://in.api.konghq.com/v3
    description: India Production region
  - url: https://sg.api.konghq.com/v3
    description: Singapore Production region
paths:
  /api-implementations:
    get:
      operationId: list-api-implementations
      summary: List API Implementations
      description: List gateway implementations for this API
      parameters:
        - $ref: "#/components/parameters/PageSize"
        - $ref: "#/components/parameters/PageNumber"
        - $ref: "#/components/parameters/ApiImplementationFilters"
        - $ref: "#/components/parameters/ApiImplementationSort"
      responses:
        "200":
          $ref: "#/components/responses/ListApiImplementationsResponse"
        "401":
          $ref: "#/components/responses/ApiUnauthorized"
        "403":
          $ref: "#/components/responses/ApiForbidden"
        "404":
          $ref: "#/components/responses/ApiNotFound"
      tags:
        - API Implementation
security:
  - konnectAccessToken: []
  - personalAccessToken: []
  - systemAccountAccessToken: []
components:
  parameters:
    PageSize:
      name: page[size]
      description: The maximum number of items to include per page. The last page of a
        collection may include fewer items.
      required: false
      in: query
      allowEmptyValue: true
      schema:
        type: integer
        example: 10
    PageNumber:
      name: page[number]
      description: Determines which page of the entities to retrieve.
      required: false
      in: query
      allowEmptyValue: true
      schema:
        type: integer
        example: 1
    ApiImplementationFilters:
      name: filter
      description: Filters APIs in the response.
      required: false
      in: query
      schema:
        $ref: "#/components/schemas/ApiImplementationFilterParameters"
      style: deepObject
    ApiImplementationSort:
      name: sort
      description: >
        Sorts a collection of API implementations. Supported sort attributes
        are:
          - id
          - api_id
          - control_plane_id
          - service_id
          - created_at
          - updated_at
      required: false
      in: query
      schema:
        $ref: "#/components/schemas/SortQuery"
  responses:
    ListApiImplementationsResponse:
      description: Paginated list of API implementations
      content:
        application/json:
          schema:
            type: object
            properties:
              meta:
                $ref: "#/components/schemas/PaginatedMeta"
              data:
                type: array
                items:
                  $ref: "#/components/schemas/ApiImplementationListItem"
            additionalProperties: false
            required:
              - data
              - meta
            title: ListApiImplementations
    ApiUnauthorized:
      description: ApiUnauthorized
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/UnauthorizedError"
          examples:
            ApiUnauthorizedExample:
              $ref: "#/components/examples/ApiUnauthorizedExample"
    ApiForbidden:
      description: ApiForbidden
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/ForbiddenError"
          examples:
            ApiForbiddenExample:
              $ref: "#/components/examples/ApiForbiddenExample"
    ApiNotFound:
      description: Not Found
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/NotFoundError"
          examples:
            ApiNotFoundExample:
              $ref: "#/components/examples/ApiNotFoundExample"
  schemas:
    ApiImplementationFilterParameters:
      type: object
      properties:
        id:
          $ref: "#/components/schemas/UuidFieldFilter"
        api_id:
          $ref: "#/components/schemas/UuidFieldFilter"
        service_id:
          $ref: "#/components/schemas/UuidFieldFilter"
        control_plane_id:
          $ref: "#/components/schemas/UuidFieldFilter"
        created_at:
          $ref: "#/components/schemas/DateTimeFieldFilter"
        updated_at:
          $ref: "#/components/schemas/DateTimeFieldFilter"
      title: API Implementation Filter Parameters
    SortQuery:
      description: >
        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').
      type: string
      example: created_at desc
      title: SortQuery
    PaginatedMeta:
      description: returns the pagination information
      type: object
      properties:
        page:
          $ref: "#/components/schemas/PageMeta"
      required:
        - page
      title: PaginatedMeta
    ApiImplementationListItem:
      description: An entity that implements an API
      type: object
      oneOf:
        - $ref: "#/components/schemas/ApiImplementationListItemGatewayServiceEntity"
        - $ref: "#/components/schemas/ApiImplementationListItemControlPlaneEntity"
      title: API Implementation List Item
    UnauthorizedError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 401
            title:
              example: Unauthorized
            type:
              example: https://httpstatuses.com/401
            instance:
              example: kong:trace:1234567890
            detail:
              example: Invalid credentials
    ForbiddenError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 403
            title:
              example: Forbidden
            type:
              example: https://httpstatuses.com/403
            instance:
              example: kong:trace:1234567890
            detail:
              example: Forbidden
    NotFoundError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 404
            title:
              example: Not Found
            type:
              example: https://httpstatuses.com/404
            instance:
              example: kong:trace:1234567890
            detail:
              example: Not found
    UuidFieldFilter:
      description: "Filter using **one** of the following operators: `eq`, `oeq`, `neq`"
      type: object
      properties:
        eq:
          description: The field exactly matches the provided value.
          type: string
          example: ?filter[field_name_here][eq]=foo
        oeq:
          description: The field matches any of the provided values.
          type: string
          example: ?filter[field_name_here][oeq]=foo,bar
        neq:
          description: The field does not match the provided value.
          type: string
          example: ?filter[field_name_here][neq]=bar
      additionalProperties: false
      x-examples:
        example-1:
          oeq: some-value,some-other-value
          neq: not-this-value
        example-2:
          eq: some-value
    DateTimeFieldFilter:
      description: Filters on the given datetime (RFC-3339) field value.
      oneOf:
        - type: string
          title: DateTimeFieldImplicitEqualsFilter
          format: date-time
          description: Value strictly equals given RFC-3339 formatted timestamp in UTC
          example: 2022-03-30T07:20:50Z
        - type: object
          title: DateTimeFieldEqualsFilter
          additionalProperties: false
          properties:
            eq:
              description: Value strictly equals given RFC-3339 formatted timestamp in UTC
              type: string
              format: date-time
              example: 2022-03-30T07:20:50Z
          required:
            - eq
        - type: object
          title: DateTimeFieldLTFilter
          additionalProperties: false
          properties:
            lt:
              description: Value is less than the given RFC-3339 formatted timestamp in UTC
              type: string
              format: date-time
              example: 2022-03-30T07:20:50Z
          required:
            - lt
        - type: object
          title: DateTimeFieldLTEFilter
          additionalProperties: false
          properties:
            lte:
              description: Value is less than or equal to the given RFC-3339 formatted
                timestamp in UTC
              type: string
              format: date-time
              example: 2022-03-30T07:20:50Z
          required:
            - lte
        - type: object
          title: DateTimeFieldGTFilter
          additionalProperties: false
          properties:
            gt:
              description: Value is greater than the given RFC-3339 formatted timestamp in UTC
              type: string
              format: date-time
              example: 2022-03-30T07:20:50Z
          required:
            - gt
        - type: object
          title: DateTimeFieldGTEFilter
          additionalProperties: false
          properties:
            gte:
              description: Value is greater than or equal to the given RFC-3339 formatted
                timestamp in UTC
              type: string
              format: date-time
              example: 2022-03-30T07:20:50Z
          required:
            - gte
      title: DateTimeFieldFilter
      x-examples:
        datetime_field_1: 2022-03-30T07:20:50Z
        datetime_field_2:
          eq: 2022-03-30T07:20:50Z
        datetime_field_3:
          lt: 2022-03-30T07:20:50Z
        datetime_field_4:
          lte: 2022-03-30T07:20:50Z
        datetime_field_5:
          gt: 2022-03-30T07:20:50Z
        datetime_field_6:
          gte: 2022-03-30T07:20:50Z
    PageMeta:
      description: Contains pagination query parameters and the total number of
        objects returned.
      type: object
      properties:
        number:
          type: number
          example: 1
        size:
          type: number
          example: 10
        total:
          type: number
          example: 100
      required:
        - number
        - size
        - total
    ApiImplementationListItemGatewayServiceEntity:
      description: An API Implementation list item for gateway services
      type: object
      properties:
        id:
          $ref: "#/components/schemas/UUID"
        created_at:
          $ref: "#/components/schemas/CreatedAt"
        updated_at:
          $ref: "#/components/schemas/UpdatedAt"
        api_id:
          description: The API identifier.
          type: string
          format: uuid
          example: 9f5061ce-78f6-4452-9108-ad7c02821fd5
          readOnly: true
        service:
          $ref: "#/components/schemas/ApiImplementationService"
      additionalProperties: false
      required:
        - id
        - api_id
        - created_at
        - updated_at
      title: ApiImplementationListItemGatewayServiceEntity
    ApiImplementationListItemControlPlaneEntity:
      description: An API Implementation list item for control planes
      type: object
      properties:
        id:
          $ref: "#/components/schemas/UUID"
        created_at:
          $ref: "#/components/schemas/CreatedAt"
        updated_at:
          $ref: "#/components/schemas/UpdatedAt"
        api_id:
          description: The API identifier.
          type: string
          format: uuid
          example: 9f5061ce-78f6-4452-9108-ad7c02821fd5
          readOnly: true
        control_plane:
          $ref: "#/components/schemas/ApiImplementationControlPlane"
      additionalProperties: false
      required:
        - id
        - api_id
        - created_at
        - updated_at
        - control_plane
      title: ApiImplementationListItemControlPlaneEntity
    BaseError:
      description: standard error
      type: object
      properties:
        status:
          description: >
            The HTTP status code of the error. Useful when passing the response

            body to child properties in a frontend UI. Must be returned as an
            integer.
          type: integer
          readOnly: true
        title:
          description: |
            A short, human-readable summary of the problem. It should not
            change between occurences of a problem, except for localization.
            Should be provided as "Sentence case" for direct use in the UI.
          type: string
          readOnly: true
        type:
          description: The error type.
          type: string
          readOnly: true
        instance:
          description: |
            Used to return the correlation ID back to the user, in the format
            kong:trace:<correlation_id>. This helps us find the relevant logs
            when a customer reports an issue.
          type: string
          readOnly: true
        detail:
          description: >
            A human readable explanation specific to this occurence of the
            problem.

            This field may contain request/entity data to help the user
            understand

            what went wrong. Enclose variable values in square brackets. Should
            be

            provided as "Sentence case" for direct use in the UI.
          type: string
          readOnly: true
      required:
        - status
        - title
        - instance
        - detail
      title: Error
    UUID:
      description: Contains a unique identifier used for this resource.
      type: string
      format: uuid
      example: 5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
      readOnly: true
    CreatedAt:
      description: An ISO-8601 timestamp representation of entity creation date.
      type: string
      format: date-time
      example: 2022-11-04T20:10:06.927Z
      readOnly: true
    UpdatedAt:
      description: An ISO-8601 timestamp representation of entity update date.
      type: string
      format: date-time
      example: 2022-11-04T20:10:06.927Z
      readOnly: true
    ApiImplementationService:
      description: A Gateway service that implements an API
      type: object
      properties:
        control_plane_id:
          type: string
          format: uuid
          example: 9f5061ce-78f6-4452-9108-ad7c02821fd5
        id:
          type: string
          format: uuid
          example: 7710d5c4-d902-410b-992f-18b814155b53
        auth_strategy_sync_error:
          allOf:
            - $ref: "#/components/schemas/AuthStrategyApiSyncError"
          readOnly: true
      additionalProperties: false
      required:
        - control_plane_id
        - id
      title: API Implementation Service
    ApiImplementationControlPlane:
      description: A Control plane that implements an API
      type: object
      properties:
        access_control_enforcement_enabled:
          description: Indicates if the access control enforcement plugin is installed
            globally in the target control plane
          type: boolean
          readOnly: true
        control_plane_id:
          type: string
          format: uuid
          example: 7710d5c4-d902-410b-992f-18b814155b53
      additionalProperties: false
      required:
        - control_plane_id
      title: API Implementation Control Plane
    AuthStrategyApiSyncError:
      type: object
      properties:
        control_plane_error:
          type: string
          enum:
            - control_plane_error_no_response
            - control_plane_error_invalid_response
            - control_plane_error_unavailable
            - control_plane_error_internal_error
            - control_plane_error_bad_request
            - control_plane_error_plugin_conflict
            - control_plane_error_data_constraint_error
            - control_plane_error_implementation_not_found
        message:
          type: string
        info:
          type: object
          additionalProperties: true
          properties:
            details:
              type: array
              items:
                type: object
                additionalProperties: true
                properties:
                  type:
                    type: string
                  message:
                    type: array
                    items:
                      type: string
      example:
        control_plane_error: control_plane_error_unavailable
        message: Unable to connect to the control plane to update plugin
      additionalProperties: false
      nullable: true
      required:
        - message
  examples:
    ApiUnauthorizedExample:
      value:
        status: 401
        title: ApiUnauthorized
        instance: kong:trace:8347343766220159418
        detail: ApiUnauthorized
    ApiForbiddenExample:
      value:
        status: 403
        title: ApiForbidden
        instance: kong:trace:2723154947768991354
        detail: You do not have permission to perform this action
    ApiNotFoundExample:
      value:
        status: 404
        title: Not Found
        instance: kong:trace:6816496025408232265
        detail: Not Found
  securitySchemes:
    konnectAccessToken:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >
        The Konnect access token is meant to be used by the Konnect dashboard
        and the decK CLI authenticate with.
    personalAccessToken:
      type: http
      scheme: bearer
      bearerFormat: Token
      description: >
        The personal access token is meant to be used as an alternative to
        basic-auth when accessing Konnect via APIs.

        You can generate a Personal Access Token (PAT) from the [personal access
        token page](https://cloud.konghq.com/global/account/tokens/) in the
        Konnect dashboard.

        The PAT token must be passed in the header of a request, for example:

        `curl -X GET 'https://global.api.konghq.com/v2/users/' --header
        'Authorization: Bearer kpat_xgfT...'`
    systemAccountAccessToken:
      type: http
      scheme: bearer
      bearerFormat: Token
      description: >
        The system account access token is meant for automations and
        integrations that are not directly associated with a human identity.

        You can generate a system account Access Token by creating a system
        account and then obtaining a system account access token for that
        account.

        The access token must be passed in the header of a request, for example:

        `curl -X GET 'https://global.api.konghq.com/v2/users/' --header
        'Authorization: Bearer spat_i2Ej...'`
```
