---
title: "ListPortalProductsResponse"
url: "https://nov18-dev.movespot.fyi/apis/portal-management-2/versions/5611abf1-a964-48d3-9512-55f58a30ef37/schemas/ListPortalProductsResponse"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/portal-management-2/versions/5611abf1-a964-48d3-9512-55f58a30ef37.md

# ListPortalProductsResponse

A paginated list of API products published to a portal.

## OpenAPI definition

```yaml
openapi: 3.0.3
info:
  title: Portal Management
  version: 2.2.2
servers:
  - url: https://us.api.konghq.com/v2
    description: United-States Production region
  - url: https://eu.api.konghq.com/v2
    description: Europe Production region
  - url: https://au.api.konghq.com/v2
    description: Australia Production region
  - url: https://me.api.konghq.com/v2
    description: Middle-East Production region
  - url: https://in.api.konghq.com/v2
    description: India Production region
  - url: https://sg.api.konghq.com/v2
    description: Singapore Production region
components:
  schemas:
    PaginatedMeta:
      description: returns the pagination information
      type: object
      properties:
        page:
          $ref: "#/components/schemas/PageMeta"
      required:
        - page
      title: PaginatedMeta
    PublishedAPIProduct:
      type: object
      properties:
        id:
          description: The API product ID.
          type: string
          format: uuid
          example: b9e81174-b5bb-4638-a3c3-8afe61a0abf8
          readOnly: true
        name:
          description: The name of the API product
          type: string
          example: My Name
        description:
          description: The description of the API product
          type: string
          example: MyDescription
          nullable: true
        portal_ids:
          description: The list of portal identifiers which this API product is published to
          type: array
          items:
            type: string
            format: uuid
            example: 25a2624c-49fc-4764-99e1-224ed819f200
          minItems: 0
          nullable: false
          uniqueItems: true
        version_count:
          description: The number of published product versions attached to this API product
          type: number
          example: 10
        created_at:
          $ref: "#/components/schemas/CreatedAt"
        updated_at:
          $ref: "#/components/schemas/UpdatedAt"
        labels:
          $ref: "#/components/schemas/Labels"
      example:
        id: 7cdcba18-5bdf-4936-81de-d76da02cb99b
        name: Excellent API
        description: Excellent for serving
        created_at: 2022-05-24T18:40:35.500Z
        updated_at: 2022-05-24T18:40:35.500Z
        portal_ids:
          - 83f1733c-862c-43e5-a005-acfb0addfcfb
        labels:
          department: marketing
        version_count: 4
      additionalProperties: false
      required:
        - id
        - name
        - description
        - portal_ids
        - created_at
        - updated_at
        - labels
        - version_count
      title: PublishedApiProduct
    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
    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
    Labels:
      description: >
        Labels store metadata of an entity that can be used for filtering an
        entity list or for searching across entity types. 


        Keys must be of length 1-63 characters, and cannot start with "kong",
        "konnect", "mesh", "kic", or "_".
      type: object
      example:
        env: test
      additionalProperties:
        type: string
        pattern: ^[a-z0-9A-Z]{1}([a-z0-9A-Z-._]*[a-z0-9A-Z]+)?$
        minLength: 1
        maxLength: 63
      maxProperties: 50
      title: Labels
    ListPortalProductsResponse:
      description: A paginated list of API products published to a portal.
      type: object
      properties:
        meta:
          $ref: "#/components/schemas/PaginatedMeta"
        data:
          type: array
          items:
            $ref: "#/components/schemas/PublishedAPIProduct"
      example:
        meta:
          page:
            number: 1
            size: 10
            total: 2
        data:
          - id: 9cdcba18-5bdf-4936-81de-d76da02cb99b
            name: Excellent API
            description: Excellent for serving
            created_at: 2022-05-24T18:40:35.500Z
            updated_at: 2022-05-24T18:40:35.500Z
            portal_ids:
              - 83f1733c-862c-43e5-a005-acfb0addfcfb
            labels:
              department: marketing
            version_count: 4
          - id: 6d8cba18-5bdf-4936-81de-d76da02cb99b
            name: Utility API
            description: Useful for helping with progress
            created_at: 2022-04-24T18:40:35.500Z
            updated_at: 2022-09-24T18:40:35.500Z
            portal_ids:
              - 83f1733c-862c-43e5-a005-acfb0addfcfb
            labels:
              department: engineering
              location: cyberspace
            version_count: 21
      additionalProperties: false
      required:
        - data
        - meta
```
