---
title: "Get applications by product version"
url: "https://nov18-dev.movespot.fyi/apis/portal-products-2/versions/e27f19d8-63a7-4a90-88ab-02bc91b51306/operations/get-applications-by-product-version"
---

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

# Get applications by product version

`GET` `/api/v2/products/{productId}/versions/{productVersionId}/applications`

Operation ID: `get-applications-by-product-version`

Get applications that have a registration for a given product version. Any registration for the version will count, regardless of status (i.e. even if it is pending, rejected, or revoked). Use the `unregistered` query param to return the inverse, only including applicatons that do not have a registration (regardless of status).

## Path parameters

- `productId` (string, uuid, required) - Contains a unique identifier used by the Portal API for this resource.
- `productVersionId` (string, uuid, required) - Contains a unique identifier used by the Portal API for this resource.

## 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[status][eq]` (string, optional) - Filter by direct equality comparison of the status property with a supplied value.
- `filter[status]` (string, optional) - Filter by direct equality comparison (short-hand) of the status property with a supplied value.
- `filter[auth_strategy_id][eq]` (string, optional) - Filter by the id of the auth strategy supported by the application.
- `filter[auth_strategy_id]` (string, optional) - Filter by the id of the auth strategy supported by the application (short-hand).
- `unregistered` (boolean, optional) - Return applications that do **not** have a registration for the product version (regardless of registration status).

## Responses

- `200` - Paginated list of applications either registered or not registered for a product version.
- `400` - Bad Request
- `401` - Unauthorized
- `404` - Not Found

## OpenAPI definition

```yaml
openapi: 3.0.3
info:
  title: Portal Products
  version: 2.0.0
paths:
  /api/v2/products/{productId}/versions/{productVersionId}/applications:
    get:
      operationId: get-applications-by-product-version
      summary: Get applications by product version
      description: >-
        Get applications that have a registration for a given product version.
        Any registration for the version will count, regardless of status (i.e.
        even if it is pending, rejected, or revoked).

        Use the `unregistered` query param to return the inverse, only including
        applicatons that do not have a registration (regardless of status).
      parameters:
        - $ref: "#/components/parameters/ProductId"
        - $ref: "#/components/parameters/ProductVersionId"
        - $ref: "#/components/parameters/PageSize"
        - $ref: "#/components/parameters/PageNumber"
        - $ref: "#/components/parameters/FilterByNameEquality"
        - $ref: "#/components/parameters/FilterByNameEqualityShort"
        - $ref: "#/components/parameters/FilterByNameContains"
        - $ref: "#/components/parameters/FilterByStatusEquality"
        - $ref: "#/components/parameters/FilterByStatusEqualityShort"
        - $ref: "#/components/parameters/FilterByAuthStrategyEquality"
        - $ref: "#/components/parameters/FilterByAuthStrategyEqualityShort"
        - $ref: "#/components/parameters/QueryUnregisteredApplications"
      responses:
        "200":
          $ref: "#/components/responses/ProductVersionListApplications"
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "404":
          $ref: "#/components/responses/NotFound"
      security:
        - portalAccessToken: []
      tags:
        - versions
security:
  - portalAccessToken: []
components:
  parameters:
    ProductId:
      name: productId
      in: path
      required: true
      description: Contains a unique identifier used by the Portal API for this resource.
      schema:
        type: string
        format: uuid
    ProductVersionId:
      name: productVersionId
      in: path
      required: true
      description: Contains a unique identifier used by the Portal API for this resource.
      schema:
        type: string
        format: uuid
    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
    FilterByStatusEquality:
      name: filter[status][eq]
      description: Filter by direct equality comparison of the status property with a
        supplied value.
      in: query
      required: false
      schema:
        type: string
        example: approved
        enum:
          - approved
          - pending
          - rejected
          - revoked
    FilterByStatusEqualityShort:
      name: filter[status]
      description: Filter by direct equality comparison (short-hand) of the status
        property with a supplied value.
      in: query
      required: false
      schema:
        type: string
        example: approved
        enum:
          - approved
          - pending
          - rejected
          - revoked
    FilterByAuthStrategyEquality:
      name: filter[auth_strategy_id][eq]
      description: Filter by the id of the auth strategy supported by the application.
      in: query
      required: false
      schema:
        type: string
        example: 5be86298-147b-45ab-bfaf-a1bff97dce39
    FilterByAuthStrategyEqualityShort:
      name: filter[auth_strategy_id]
      description: Filter by the id of the auth strategy supported by the application
        (short-hand).
      in: query
      required: false
      schema:
        type: string
        example: 5be86298-147b-45ab-bfaf-a1bff97dce39
    QueryUnregisteredApplications:
      name: unregistered
      description: Return applications that do **not** have a registration for the
        product version (regardless of registration status).
      in: query
      required: false
      schema:
        type: boolean
      allowEmptyValue: true
  responses:
    ProductVersionListApplications:
      description: Paginated list of applications either registered or not registered
        for a product version.
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/ProductVersionListApplicationsPage"
    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"
    NotFound:
      description: Not Found
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/NotFoundError"
          examples:
            NotFoundExample:
              $ref: "#/components/examples/NotFoundExample"
  schemas:
    ProductVersionListApplicationsPage:
      type: object
      properties:
        meta:
          $ref: "#/components/schemas/PaginatedMeta"
        data:
          type: array
          items:
            $ref: "#/components/schemas/ProductVersionApplication"
      additionalProperties: false
      required:
        - meta
        - data
      title: ProductVersionListApplicationsPage
    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
    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
    PaginatedMeta:
      description: returns the pagination information
      type: object
      properties:
        page:
          $ref: "#/components/schemas/PageMeta"
      required:
        - page
      title: PaginatedMeta
    ProductVersionApplication:
      type: object
      properties:
        id:
          $ref: "#/components/schemas/UUID"
        name:
          description: The name of the application
          type: string
        registration_id:
          $ref: "#/components/schemas/NullableUUID"
        registration_status:
          type: string
          enum:
            - approved
            - pending
            - rejected
            - revoked
          nullable: true
        auth_strategy:
          $ref: "#/components/schemas/AuthStrategy"
        created_at:
          $ref: "#/components/schemas/CreatedAt"
        updated_at:
          $ref: "#/components/schemas/UpdatedAt"
      additionalProperties: false
      required:
        - id
        - name
        - created_at
        - updated_at
        - registration_status
        - registration_id
      title: ProductVersionApplication
    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
    NullableUUID:
      description: Contains a unique identifier for a resource.
      type: string
      format: uuid
      example: 5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
      nullable: true
    AuthStrategy:
      type: object
      discriminator:
        propertyName: credential_type
      oneOf:
        - $ref: "#/components/schemas/AuthStrategyKeyAuth"
        - $ref: "#/components/schemas/AuthStrategyClientCredentials"
    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
    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
    AuthStrategyKeyAuth:
      description: KeyAuth Auth strategy that the application uses.
      type: object
      properties:
        id:
          description: The Application Auth Strategy ID.
          type: string
          format: uuid
          example: b9e81174-b5bb-4638-a3c3-8afe61a0abf8
          readOnly: true
        name:
          type: string
          example: name
          default: name
        credential_type:
          type: string
          enum:
            - key_auth
        key_names:
          type: array
          items:
            type: string
        ttl:
          description: Default maximum Time-To-Live for keys created under this strategy.
          type: object
          properties:
            value:
              type: integer
              minimum: 1
            unit:
              type: string
              enum:
                - days
                - weeks
                - years
          required:
            - value
            - unit
      additionalProperties: false
      required:
        - id
        - name
        - credential_type
        - key_names
    AuthStrategyClientCredentials:
      description: Client Credential Auth strategy that the application uses.
      type: object
      properties:
        id:
          description: The Application Auth Strategy ID.
          type: string
          format: uuid
          example: b9e81174-b5bb-4638-a3c3-8afe61a0abf8
          readOnly: true
        name:
          type: string
          example: name
          default: name
        credential_type:
          type: string
          enum:
            - client_credentials
            - self_managed_client_credentials
        auth_methods:
          $ref: "#/components/schemas/AuthMethods"
        available_scopes:
          $ref: "#/components/schemas/AvailableScopes"
      additionalProperties: false
      required:
        - id
        - name
        - credential_type
        - auth_methods
    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
    AuthMethods:
      type: array
      items:
        description: Auth Methods enabled for this strategy
        type: string
      example:
        - bearer
    AvailableScopes:
      description: Possible developer selectable scopes for an application. Only
        present when using DCR Provider that supports it.
      type: array
      items:
        type: string
      example:
        - scope1
        - scope2
  examples:
    UnauthorizedExample:
      value:
        status: 401
        title: Unauthorized
        instance: kong:trace:8347343766220159418
        detail: Unauthorized
    NotFoundExample:
      value:
        status: 404
        title: Not Found
        instance: kong:trace:6816496025408232265
        detail: Not Found
  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.
```
