---
title: "SearchResults"
url: "https://nov18-dev.movespot.fyi/apis/portal-search-2/versions/2775d480-6d49-4d32-a9b4-5a43edc6cc32/schemas/PortalSearchResults"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/portal-search-2/versions/2775d480-6d49-4d32-a9b4-5a43edc6cc32.md

# SearchResults

## OpenAPI definition

```yaml
openapi: 3.0.0
info:
  title: Portal Search
  version: 3.0.4
components:
  schemas:
    CursorMeta:
      description: Pagination metadata.
      type: object
      properties:
        page:
          $ref: "#/components/schemas/CursorMetaPage"
      required:
        - page
    PortalSearchResultOperation:
      type: object
      properties:
        id:
          description: Unique identifier for the record.
          type: string
        type:
          description: Portal entity type.
          type: string
        name:
          description: Name of the entity.
          type: string
        match:
          description: The matched text from the record.
          type: string
        description:
          description: Description of the entity.
          type: string
        attributes:
          description: Attributes for the entity.
          type: object
          additionalProperties: false
          properties:
            created_at:
              $ref: "#/components/schemas/CreatedAt"
            updated_at:
              $ref: "#/components/schemas/UpdatedAt"
            operation_id:
              description: The operation ID of the operation.
              type: string
            operation_key:
              description: The operation key of the operation.
              type: string
            path:
              description: The path of the operation.
              type: string
            method:
              description: The method of the operation.
              type: string
            scope:
              description: The scope of the operation.
              type: string
            summary:
              description: The summary of the operation.
              type: string
            api_description:
              description: The description of the API.
              type: string
            api_name:
              description: The name of the API.
              type: string
            api_slug:
              description: The URL slug of the API.
              type: string
            api_version:
              description: The version of the API.
              type: string
          required:
            - created_at
            - updated_at
            - operation_id
            - operation_key
            - path
            - method
            - scope
            - summary
            - api_description
            - api_name
            - api_slug
            - api_version
        relations:
          description: Relations for the entity.
          type: object
          additionalProperties: false
          properties:
            api_id:
              description: The ID of the API.
              type: string
            spec_id:
              description: The ID of the API specification.
              type: string
            portal_id:
              description: The ID of the portal.
              type: string
            org_id:
              description: The ID of the organization.
              type: string
            api_name:
              description: The name of the API.
              type: string
            api_slug:
              description: The slug of the API.
              type: string
            api_version:
              description: The version of the API.
              type: string
            api_description:
              description: The description of the API.
              type: string
          required:
            - api_id
            - spec_id
            - portal_id
            - org_id
            - api_name
            - api_slug
            - api_version
            - api_description
      additionalProperties: false
      required:
        - id
        - type
        - name
        - match
        - description
        - attributes
        - relations
      title: SearchResultOperation
    PortalSearchResultDocument:
      type: object
      properties:
        id:
          description: Unique identifier for the record.
          type: string
        type:
          description: Portal entity type.
          type: string
        name:
          description: Name of the entity.
          type: string
        match:
          description: The matched text from the record.
          type: string
        description:
          description: Description of the entity.
          type: string
        attributes:
          description: Attributes for the entity.
          type: object
          additionalProperties: false
          properties:
            created_at:
              $ref: "#/components/schemas/CreatedAt"
            updated_at:
              $ref: "#/components/schemas/UpdatedAt"
            path:
              description: The path of the operation.
              type: string
            scope:
              description: The scope of the operation.
              type: string
            api_slug:
              description: The URL slug of the API.
              type: string
            parent_document_id:
              description: The ID of the parent document if one exists.
              type: string
            slug:
              description: The URL slug of the document.
              type: string
          required:
            - created_at
            - updated_at
            - path
            - scope
            - api_slug
            - parent_document_id
            - slug
        relations:
          description: Relations for the entity.
          type: object
          additionalProperties: false
          properties:
            api_id:
              description: The ID of the API.
              type: string
            spec_id:
              description: The ID of the API specification.
              type: string
            portal_id:
              description: The ID of the portal.
              type: string
            org_id:
              description: The ID of the organization.
              type: string
            api_slug:
              description: The slug of the API.
              type: string
            api_version:
              description: The version of the API.
              type: string
            api_description:
              description: The description of the API.
              type: string
            parent_document_id:
              description: The ID of the parent document if one exists.
              type: string
            path:
              description: The path of the document.
              type: string
            slug:
              description: The URL slug of the document.
              type: string
          required:
            - api_id
            - spec_id
            - portal_id
            - org_id
            - api_slug
            - api_version
            - api_description
            - parent_document_id
            - path
            - slug
      additionalProperties: false
      required:
        - id
        - type
        - name
        - match
        - description
        - attributes
        - relations
      title: SearchResultDocument
    CursorMetaPage:
      type: object
      properties:
        first:
          description: URI to the first page
          type: string
          format: path
        last:
          description: URI to the last page
          type: string
          format: path
        next:
          description: URI to the next page
          type: string
          format: path
          nullable: true
        previous:
          description: URI to the previous page
          type: string
          format: path
          nullable: true
        size:
          description: Requested page size
          type: number
          example: 10
      required:
        - size
        - next
        - previous
    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
    PortalSearchResults:
      type: object
      properties:
        meta:
          $ref: "#/components/schemas/CursorMeta"
        data:
          description: The paginated results that matched the search query
          type: array
          items:
            oneOf:
              - $ref: "#/components/schemas/PortalSearchResultOperation"
              - $ref: "#/components/schemas/PortalSearchResultDocument"
      additionalProperties: false
      required:
        - data
        - meta
      title: SearchResults
```
