---
title: "Get a Snippet"
method: GET
path: "/v3/portals/{portalId}/snippets/{snippetId}"
tags: ["Snippets"]
---

# Get a Snippet

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

## Request

- Base URL: `https://global.api.konghq.com`
- URL: `https://global.api.konghq.com/v3/portals/{portalId}/snippets/{snippetId}`
- Auth: one of:
  - HTTP bearer
  - HTTP bearer
  - HTTP bearer
  - HTTP bearer
- TypeScript: <https://skmtc.dev/kong/apis/konnect-api/docs/v3/portals/:portalId/snippets/:snippetId/get.ts> (a function with typed inputs; its response is checked against the schema)

Returns the configuration of a single custom snippet for this portal. Custom snippets can be used to display static content, documentation, or other information to developers.

## Path parameters

- `portalId` string, uuid, required
- `snippetId` string, uuid, required

## Response `200`

Details about a snippet in a portal.

- PortalSnippetResponse: Details about a snippet in a portal.
  - `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: The display title of a snippet in a portal.
  - `content` string, required: The renderable markdown content of a page 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.

## Other responses

- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found

## Changes

- **2026-09-30** `f530bf400198`: 2 warning
  - 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-25** `4a02153f2e60`: 2 breaking, 17 info
  - 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 `401`
  - removed `#/components/schemas/BaseError, subschema #2` from the response body `allOf` list for the response status `403`
  - …15 more
- **2025-08-22** `96118a9cd7f4`: 1 info
  - endpoint added

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

---

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