---
title: "List Portal Entities via Search"
url: "https://nov18-dev.movespot.fyi/apis/portal-search-2/versions/27ea8baa-a891-4d7b-9c82-b7123e17bb02/operations/search-portal-entities"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/portal-search-2/versions/27ea8baa-a891-4d7b-9c82-b7123e17bb02.md

# List Portal Entities via Search

`GET` `/api/v2/search/{indices}`

Operation ID: `search-portal-entities`

Returns paginated search results from the specified entities with the given search parameters.

## Path parameters

- `indices` (string, required) - Determines which entity sets to search

## Query parameters

- `q` (string, optional) - Determines how to filter search results
- `join` (string, optional) - Determines which sub-entities to include in search results
- `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.

## Responses

- `200` - Search Results
- `400` - Bad Request
- `401` - Unauthorized

## OpenAPI definition

```yaml
openapi: 3.0.0
info:
  title: Portal Search
  version: 2.0.0
paths:
  /api/v2/search/{indices}:
    get:
      operationId: search-portal-entities
      summary: List Portal Entities via Search
      description: Returns paginated search results from the specified entities with
        the given search parameters.
      parameters:
        - $ref: "#/components/parameters/SearchIndices"
        - $ref: "#/components/parameters/SearchQuery"
        - $ref: "#/components/parameters/SearchJoin"
        - $ref: "#/components/parameters/PageSize"
        - $ref: "#/components/parameters/PageNumber"
      responses:
        "200":
          $ref: "#/components/responses/SearchResponse"
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
      security:
        - portalAccessToken: []
        - {}
      tags:
        - search
security:
  - portalAccessToken: []
  - {}
components:
  parameters:
    SearchIndices:
      name: indices
      description: Determines which entity sets to search
      required: true
      in: path
      schema:
        $ref: "#/components/schemas/SearchIndicesParameters"
    SearchQuery:
      name: q
      description: Determines how to filter search results
      required: false
      in: query
      schema:
        $ref: "#/components/schemas/SearchQueryParameters"
    SearchJoin:
      name: join
      description: Determines which sub-entities to include in search results
      required: false
      in: query
      schema:
        $ref: "#/components/schemas/SearchJoinParameters"
    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
  responses:
    SearchResponse:
      description: Search Results
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/SearchResults"
          examples:
            Search Response Example:
              $ref: "#/components/examples/SearchResponseExample"
    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:
    SearchIndicesParameters:
      type: string
      enum:
        - product-catalog
      title: SearchIndicesParameters
    SearchQueryParameters:
      type: string
      title: SearchQueryParameters
    SearchJoinParameters:
      description: Accepted values are `versions` and `versions.documents`. Use commas
        to separate multiple values.
      type: string
      example: versions,versions.documents
      title: SearchJoinParameters
    SearchResults:
      type: object
      properties:
        meta:
          $ref: "#/components/schemas/PaginatedMeta"
        data:
          description: The paginated results that matched the search query
          type: array
          items:
            type: object
            additionalProperties: false
            properties:
              index:
                $ref: "#/components/schemas/SearchIndicesParameters"
              source:
                $ref: "#/components/schemas/ProductCatalogIndexSource"
            required:
              - index
              - source
      additionalProperties: false
      required:
        - data
        - meta
      title: SearchResults
    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
    ProductCatalogIndexSource:
      type: object
      properties:
        id:
          $ref: "#/components/schemas/UUID"
        name:
          description: the name of the product
          type: string
          example: Nice Product
          nullable: true
          readOnly: true
        description:
          description: a description of the product
          type: string
          example: A nice product for customers to read about and consume
          nullable: true
          readOnly: true
        created_at:
          $ref: "#/components/schemas/CreatedAt"
        updated_at:
          $ref: "#/components/schemas/UpdatedAt"
        document_count:
          description: Number of product documents available.
          type: number
          example: 5
          readOnly: true
        version_count:
          description: Number of product versions.
          type: number
          example: 2
          readOnly: true
        latest_version:
          description: Last created version.
          type: object
          additionalProperties: false
          nullable: true
          properties:
            name:
              description: Name of product version.
              type: string
              example: v2.0.0
            id:
              $ref: "#/components/schemas/UUID"
          required:
            - name
            - id
        public_labels:
          $ref: "#/components/schemas/PublicLabels"
      additionalProperties: false
      required:
        - id
        - created_at
        - updated_at
        - name
        - document_count
        - version_count
        - latest_version
        - public_labels
      title: ProductCatalogIndexSource
    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
    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:
    SearchResponseExample:
      value:
        data:
          - index: product-catalog
            source:
              created_at: 2023-01-19T17:41:55.896Z
              updated_at: 2023-01-20T17:41:55.896Z
              id: e35b0beb-c3f7-4f8f-95f7-cd8ff0ee478e
              name: Great Product
              description: Great products are built with great care
              document_count: 5
              version_count: 5
              public_labels:
                env: test
              latest_version:
                name: v5
                id: 455b0beb-c3f7-4f8f-95f7-cd8ff0ee478e
        meta:
          page:
            number: 1
            size: 10
            total: 4
    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.
```
