---
title: "List Snippets"
method: GET
path: "/v3/portals/{portalId}/snippets"
tags: ["Snippets"]
---

# List Snippets

`GET /v3/portals/{portalId}/snippets`

## Request

- Base URL: `https://global.api.konghq.com`
- URL: `https://global.api.konghq.com/v3/portals/{portalId}/snippets`
- Auth: one of:
  - HTTP bearer
  - HTTP bearer
  - HTTP bearer
  - HTTP bearer

Returns the paginated list of custom snippets that have been created for this portal.

## Path parameters

- `portalId` string, uuid, required

## Query parameters

- `sort` string
- `page[size]` integer
- `page[number]` integer
- `filter` PortalSnippetsFilterParameters
  - `id` UuidFieldFilter: Filter using **one** of the following operators: `eq`, `oeq`, `neq`
    - `eq` string: The field exactly matches the provided value.
    - `oeq` string: The field matches any of the provided values.
    - `neq` string: The field does not match the provided value.
  - `name` StringFieldFilter: Filter using **one** of the following operators: `eq`, `oeq`, `neq`, `contains`, `ocontains`
    - `eq` string: The field exactly matches the provided value.
    - `contains` string: The field contains the provided value.
    - `ocontains` string: The field contains any of the provided values.
    - `oeq` string: The field matches any of the provided values.
    - `neq` string: The field does not match the provided value.
  - `title` StringFieldFilter: Filter using **one** of the following operators: `eq`, `oeq`, `neq`, `contains`, `ocontains`
    - `eq` string: The field exactly matches the provided value.
    - `contains` string: The field contains the provided value.
    - `ocontains` string: The field contains any of the provided values.
    - `oeq` string: The field matches any of the provided values.
    - `neq` string: The field does not match the provided value.
  - `visibility` StringFieldFilter: Filter using **one** of the following operators: `eq`, `oeq`, `neq`, `contains`, `ocontains`
    - `eq` string: The field exactly matches the provided value.
    - `contains` string: The field contains the provided value.
    - `ocontains` string: The field contains any of the provided values.
    - `oeq` string: The field matches any of the provided values.
    - `neq` string: The field does not match the provided value.
  - `created_at` union: Filters on the given datetime (RFC-3339) field value.
    - object
      - `eq` string, date-time, required: Value strictly equals given RFC-3339 formatted timestamp in UTC
    - object
      - `lt` string, date-time, required: Value is less than the given RFC-3339 formatted timestamp in UTC
    - object
      - `lte` string, date-time, required: Value is less than or equal to the given RFC-3339 formatted timestamp in UTC
    - object
      - `gt` string, date-time, required: Value is greater than the given RFC-3339 formatted timestamp in UTC
    - object
      - `gte` string, date-time, required: Value is greater than or equal to the given RFC-3339 formatted timestamp in UTC
  - `updated_at` union: Filters on the given datetime (RFC-3339) field value.
    - object
      - `eq` string, date-time, required: Value strictly equals given RFC-3339 formatted timestamp in UTC
    - object
      - `lt` string, date-time, required: Value is less than the given RFC-3339 formatted timestamp in UTC
    - object
      - `lte` string, date-time, required: Value is less than or equal to the given RFC-3339 formatted timestamp in UTC
    - object
      - `gt` string, date-time, required: Value is greater than the given RFC-3339 formatted timestamp in UTC
    - object
      - `gte` string, date-time, required: Value is greater than or equal to the given RFC-3339 formatted timestamp in UTC

## Response `200`

A paginated list of custom snippets in a portal.

- ListPortalSnippetsResponse: A paginated list of custom snippets in a portal.
  - `data` PortalSnippetInfo[], required
    - `id` string, uuid, required: Contains a unique identifier used for this resource.
    - `name` string, required: The unique name of a snippet in a portal.
    - `title` string, required: The display title of a snippet in a portal.
    - `visibility` 'public' | 'private', required: Whether the resource is publicly accessible to non-authenticated users.
    - `status` 'published' | 'unpublished', required: Whether the resource is visible on a given portal. Defaults to unpublished.
    - `description` string
    - `created_at` string, date-time, required: An ISO-8601 timestamp representation of entity creation date.
    - `updated_at` string, date-time, required: An ISO-8601 timestamp representation of entity update date.
  - `meta` PaginatedMeta, required: returns the pagination information
    - `page` PageMeta, required: Contains pagination query parameters and the total number of objects returned.
      - `number` number, required
      - `size` number, required
      - `total` number, required

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found

## Changes

- **2026-10-15** `7aab863a6daa`: 1 breaking, 2 warning
  - added `#/components/schemas/InvalidParameterMinimumTime, #/components/schemas/InvalidParameterMaximumTime` to the `invalid_parameters/items/` response property `oneOf` list for the response status `400`
  - added the new `key_invalid` enum value to the `invalid_parameters/items/oneOf[#/components/schemas/InvalidParameterStandard]/rule` response property for the response status `400`
  - added the new `unique` enum value to the `invalid_parameters/items/oneOf[#/components/schemas/InvalidParameterStandard]/rule` response property for the response status `400`
- **2026-09-25** `68d43091b84d`: 3 warning
  - added the new `400.00` enum value to the `status` response property for the response status `400`
  - added the new `403.00` enum value to the `status` response property for the response status `403`
  - added the new `404.00` enum value to the `status` response property for the response status `404`
- **2026-09-18** `f324fb7610e4`: 3 breaking, 24 info
  - the response's body type changed from no type to `object` for status `400`
  - the response's body type changed from no type to `object` for status `403`
  - the response's body type changed from no type to `object` for status `404`
  - removed `#/components/schemas/BaseError, subschema #2` from the response body `allOf` list for the response status `400`
  - …23 more
- …earlier changes not shown

[Operation history](https://skmtc.dev/kong/apis/konnect-api-go-sdk/changes/v3/portals/:portalId/snippets/get.md)

---

[API](https://skmtc.dev/kong/apis/konnect-api-go-sdk.md) · [All operations](https://skmtc.dev/kong/apis/konnect-api-go-sdk/llms.txt) · [OpenAPI document](https://skmtc.dev/kong/apis/konnect-api-go-sdk/revisions/7aab863a6daa?raw)