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

# Get a Snippet

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

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

---

[API](https://skmtc.net/kong/apis/konnect-api-beta.md) · [All operations](https://skmtc.net/kong/apis/konnect-api-beta/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/kong/konnect-api-beta/revisions/73b05fbfd2ef/schema)