---
title: "List Products"
url: "https://nov18-dev.movespot.fyi/apis/portal-products-2/versions/e27f19d8-63a7-4a90-88ab-02bc91b51306/operations/list-products"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/portal-products-2/versions/e27f19d8-63a7-4a90-88ab-02bc91b51306.md

# List Products

`GET` `/api/v2/products`

Operation ID: `list-products`

Returns a paginated list of published API Products.

## 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[name][eq]` (string, optional) - Filter by direct equality comparison of the name property with a supplied value.
- `filter[name]` (string, optional) - Filter by direct equality comparison (short-hand) of the name property with a supplied value.
- `filter[name][contains]` (string, optional) - Filter by contains comparison of the name property with a supplied substring
- `filter[description][eq]` (string, optional) - Filter by direct equality comparison of the description property with a supplied value.
- `filter[description]` (string, optional) - Filter by direct equality comparison (short-hand) of the description property with a supplied value.
- `filter[description][contains]` (string, optional) - Filter by contains comparison of the description property with a supplied substring
- `filter[id][eq]` (string, optional) - Filter by direct equality comparison of the id property with a supplied value.
- `filter[id]` (string, optional) - Filter by direct equality comparison (short-hand) of the id property with a supplied value.

## Responses

- `200` - Response for a list of products.
- `400` - Bad Request
- `401` - Unauthorized

## OpenAPI definition

```yaml
openapi: 3.0.3
info:
  title: Portal Products
  version: 2.0.0
paths:
  /api/v2/products:
    get:
      operationId: list-products
      summary: List Products
      description: Returns a paginated list of published API Products.
      parameters:
        - $ref: "#/components/parameters/PageSize"
        - $ref: "#/components/parameters/PageNumber"
        - $ref: "#/components/parameters/FilterByNameEquality"
        - $ref: "#/components/parameters/FilterByNameEqualityShort"
        - $ref: "#/components/parameters/FilterByNameContains"
        - $ref: "#/components/parameters/FilterByDescriptionEquality"
        - $ref: "#/components/parameters/FilterByDescriptionEqualityShort"
        - $ref: "#/components/parameters/FilterByDescriptionContains"
        - $ref: "#/components/parameters/FilterByIdEquality"
        - $ref: "#/components/parameters/FilterByIdEqualityShort"
      responses:
        "200":
          $ref: "#/components/responses/ProductList"
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
      security:
        - portalAccessToken: []
        - {}
      tags:
        - products
security:
  - portalAccessToken: []
  - {}
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
    FilterByNameEquality:
      name: filter[name][eq]
      description: Filter by direct equality comparison of the name property with a
        supplied value.
      in: query
      required: false
      schema:
        type: string
        example: good service
    FilterByNameEqualityShort:
      name: filter[name]
      description: Filter by direct equality comparison (short-hand) of the name
        property with a supplied value.
      in: query
      required: false
      schema:
        type: string
        example: good service
    FilterByNameContains:
      name: filter[name][contains]
      description: Filter by contains comparison of the name property with a supplied
        substring
      in: query
      required: false
      schema:
        type: string
        example: good service
    FilterByDescriptionEquality:
      name: filter[description][eq]
      description: Filter by direct equality comparison of the description property
        with a supplied value.
      in: query
      required: false
      schema:
        type: string
        example: portal
    FilterByDescriptionEqualityShort:
      name: filter[description]
      description: Filter by direct equality comparison (short-hand) of the
        description property with a supplied value.
      in: query
      required: false
      schema:
        type: string
        example: portal
    FilterByDescriptionContains:
      name: filter[description][contains]
      description: Filter by contains comparison of the description property with a
        supplied substring
      in: query
      required: false
      schema:
        type: string
        example: portal
    FilterByIdEquality:
      name: filter[id][eq]
      description: Filter by direct equality comparison of the id property with a
        supplied value.
      in: query
      required: false
      schema:
        type: string
        example: 5be86298-147b-45ab-bfaf-a1bff97dce39
    FilterByIdEqualityShort:
      name: filter[id]
      description: Filter by direct equality comparison (short-hand) of the id
        property with a supplied value.
      in: query
      required: false
      schema:
        type: string
        example: 5be86298-147b-45ab-bfaf-a1bff97dce39
  responses:
    ProductList:
      description: Response for a list of products.
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/ProductListPage"
    BadRequest:
      description: Bad Request
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/BadRequestError"
    Unauthorized:
      description: Unauthorized
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/UnauthorizedError"
          examples:
            UnauthorizedExample:
              $ref: "#/components/examples/UnauthorizedExample"
  schemas:
    ProductListPage:
      type: object
      properties:
        meta:
          $ref: "#/components/schemas/PaginatedMeta"
        data:
          type: array
          items:
            $ref: "#/components/schemas/Product"
      title: ProductListPage
    BadRequestError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          required:
            - invalid_parameters
          properties:
            invalid_parameters:
              $ref: "#/components/schemas/InvalidParameters"
    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
    PaginatedMeta:
      description: returns the pagination information
      type: object
      properties:
        page:
          $ref: "#/components/schemas/PageMeta"
      required:
        - page
      title: PaginatedMeta
    Product:
      type: object
      properties:
        id:
          $ref: "#/components/schemas/UUID"
        created_at:
          $ref: "#/components/schemas/CreatedAt"
        updated_at:
          $ref: "#/components/schemas/UpdatedAt"
        name:
          description: Name of product.
          type: string
          example: Billing
        description:
          type: string
          example: API for billing functions
          nullable: true
        document_count:
          description: Number of linked documents in documentation.
          type: integer
          example: 3
          readOnly: true
        version_count:
          description: Number of published versions.
          type: integer
          example: 2
          readOnly: true
        latest_version:
          $ref: "#/components/schemas/LatestVersion"
        public_labels:
          $ref: "#/components/schemas/PublicLabels"
      additionalProperties: false
      required:
        - id
        - public_labels
        - created_at
        - updated_at
        - name
      title: Product
    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
    InvalidParameters:
      description: invalid parameters
      type: array
      items:
        oneOf:
          - $ref: "#/components/schemas/InvalidParameterStandard"
          - $ref: "#/components/schemas/InvalidParameterMinimumLength"
          - $ref: "#/components/schemas/InvalidParameterMaximumLength"
          - $ref: "#/components/schemas/InvalidParameterChoiceItem"
          - $ref: "#/components/schemas/InvalidParameterDependentItem"
      minItems: 1
      nullable: false
      uniqueItems: true
    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
    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
    LatestVersion:
      type: object
      properties:
        name:
          type: string
          example: v2.0.0
          readOnly: true
        id:
          $ref: "#/components/schemas/UUID"
      additionalProperties: false
      nullable: true
    PublicLabels:
      description: >
        Public labels store information about an entity that can be used for
        filtering a list of objects.


        Public labels are intended to store **PUBLIC** metadata. 


        Keys must be of length 1-63 characters, and cannot start with "kong",
        "konnect", "mesh", "kic", or "_".
      type: object
      example:
        category: finance
      additionalProperties:
        type: string
        pattern: ^[a-z0-9A-Z]{1}([a-z0-9A-Z-._]*[a-z0-9A-Z]+)?$
        minLength: 1
        maxLength: 63
      maxProperties: 50
      title: PublicLabels
    InvalidParameterStandard:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          $ref: "#/components/schemas/InvalidRules"
        source:
          type: string
          example: body
        reason:
          type: string
          example: is a required field
          readOnly: true
      additionalProperties: false
      required:
        - field
        - reason
    InvalidParameterMinimumLength:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          enum:
            - min_length
            - min_digits
            - min_lowercase
            - min_uppercase
            - min_symbols
            - min_items
            - min
          nullable: false
          readOnly: true
        minimum:
          type: integer
          example: 8
        source:
          type: string
          example: body
        reason:
          type: string
          example: must have at least 8 characters
          readOnly: true
      additionalProperties: false
      required:
        - field
        - reason
        - rule
        - minimum
    InvalidParameterMaximumLength:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          enum:
            - max_length
            - max_items
            - max
          nullable: false
          readOnly: true
        maximum:
          type: integer
          example: 8
        source:
          type: string
          example: body
        reason:
          type: string
          example: must not have more than 8 characters
          readOnly: true
      additionalProperties: false
      required:
        - field
        - reason
        - rule
        - maximum
    InvalidParameterChoiceItem:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          enum:
            - enum
          nullable: false
          readOnly: true
        reason:
          type: string
          example: is a required field
          readOnly: true
        choices:
          type: array
          items: {}
          minItems: 1
          nullable: false
          readOnly: true
          uniqueItems: true
        source:
          type: string
          example: body
      additionalProperties: false
      required:
        - field
        - reason
        - rule
        - choices
    InvalidParameterDependentItem:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          enum:
            - dependent_fields
          nullable: true
          readOnly: true
        reason:
          type: string
          example: is a required field
          readOnly: true
        dependents:
          type: array
          items: {}
          nullable: true
          readOnly: true
          uniqueItems: true
        source:
          type: string
          example: body
      additionalProperties: false
      required:
        - field
        - rule
        - reason
        - dependents
    InvalidRules:
      description: invalid parameters rules
      type: string
      enum:
        - required
        - is_array
        - is_base64
        - is_boolean
        - is_date_time
        - is_integer
        - is_null
        - is_number
        - is_object
        - is_string
        - is_uuid
        - is_fqdn
        - is_arn
        - unknown_property
        - missing_reference
        - is_label
        - matches_regex
        - invalid
        - is_supported_network_availability_zone_list
        - is_supported_network_cidr_block
        - is_supported_provider_region
        - type
      nullable: true
      readOnly: true
  examples:
    UnauthorizedExample:
      value:
        status: 401
        title: Unauthorized
        instance: kong:trace:8347343766220159418
        detail: Unauthorized
  securitySchemes:
    portalAccessToken:
      type: apiKey
      in: cookie
      name: portalaccesstoken
      description: >
        The Developer portal cookie is meant to be used by the Developer API to
        authenticate with.
```
