---
title: "ListPortalSnippetsResponse"
url: "https://nov18-dev.movespot.fyi/apis/portal-management-v3-3/versions/209d0e93-97b5-4dd3-a5a4-172ba6d8a51e/schemas/ListPortalSnippetsResponse"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/portal-management-v3-3/versions/209d0e93-97b5-4dd3-a5a4-172ba6d8a51e.md

# ListPortalSnippetsResponse

A paginated list of custom snippets in a portal.

## OpenAPI definition

```yaml
openapi: 3.0.3
info:
  title: Portal Management V3
  version: 3.4.1
servers:
  - url: https://us.api.konghq.com/v3
    description: United-States Production region
  - url: https://eu.api.konghq.com/v3
    description: Europe Production region
  - url: https://au.api.konghq.com/v3
    description: Australia Production region
  - url: https://me.api.konghq.com/v3
    description: Middle-East Production region
  - url: https://in.api.konghq.com/v3
    description: India Production region
  - url: https://sg.api.konghq.com/v3
    description: Singapore Production region
components:
  schemas:
    PortalSnippetInfo:
      description: Information about a snippet in a portal.
      type: object
      properties:
        id:
          $ref: "#/components/schemas/UUID"
        name:
          $ref: "#/components/schemas/SnippetName"
        title:
          $ref: "#/components/schemas/SnippetTitle"
        visibility:
          $ref: "#/components/schemas/VisibilityStatus"
        status:
          $ref: "#/components/schemas/PublishedStatus"
        description:
          $ref: "#/components/schemas/Description"
        created_at:
          $ref: "#/components/schemas/CreatedAt"
        updated_at:
          $ref: "#/components/schemas/UpdatedAt"
      additionalProperties: false
      required:
        - id
        - name
        - title
        - visibility
        - status
        - created_at
        - updated_at
      title: PortalSnippetInfo
    PaginatedMeta:
      description: returns the pagination information
      type: object
      properties:
        page:
          $ref: "#/components/schemas/PageMeta"
      required:
        - page
      title: PaginatedMeta
    UUID:
      description: Contains a unique identifier used for this resource.
      type: string
      format: uuid
      example: 5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
      readOnly: true
    SnippetName:
      description: The unique name of a snippet in a portal.
      type: string
      example: my-snippet
      maxLength: 512
      title: SnippetName
    SnippetTitle:
      description: The display title of a snippet in a portal.
      type: string
      example: My Snippet
      maxLength: 512
      title: SnippetTitle
    VisibilityStatus:
      description: Whether the resource is publicly accessible to non-authenticated users.
      type: string
      example: public
      enum:
        - public
        - private
      title: VisibilityStatus
    PublishedStatus:
      description: Whether the resource is visible on a given portal. Defaults to
        unpublished.
      type: string
      example: published
      enum:
        - published
        - unpublished
      title: PublishedStatus
    Description:
      type: string
      example: A custom page about developer portals
      maxLength: 160
      title: ResourceDescription
    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
    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
    ListPortalSnippetsResponse:
      description: A paginated list of custom snippets in a portal.
      type: object
      properties:
        data:
          type: array
          items:
            $ref: "#/components/schemas/PortalSnippetInfo"
        meta:
          $ref: "#/components/schemas/PaginatedMeta"
      example:
        data:
          - id: 437c7192-fea0-4f35-8478-c8d57783f8c1
            name: my-snippet
            title: My Snippet
            visibility: public
            status: published
            description: A custom snippet
            created_at: 2021-01-01T00:00:00Z
            updated_at: 2021-01-01T00:00:00Z
        meta:
          page:
            number: 1
            size: 10
            total: 1
      additionalProperties: false
      required:
        - data
        - meta
      title: ListPortalSnippetsResponse
```
