---
title: "Get integration snippets"
method: GET
path: "/v2/{tenant_slug}/snippet"
tags: ["Snippet"]
---

# Get integration snippets

`GET /v2/{tenant_slug}/snippet`

## Request

- Base URL: `https://api.demo-retail.urbanfox.io`
- URL: `https://api.demo-retail.urbanfox.io/v2/{tenant_slug}/snippet`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://api.demo-retail.urbanfox.io/v2/oauth/token` scopes: `read:snippet`
- TypeScript: <https://skmtc.dev/urbanfox/apis/urbanfox-customer-api/docs/v2/:tenant_slug/snippet/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieve integration snippets and identifiers for a tenant.

## Path parameters

- `tenant_slug` string, required: Tenant DNS slug (lowercase letters, digits, and hyphens; 3-100 characters).

## Response `200`

Successful Response

- APIResponseSnippetResponse
  - `data` SnippetResponse, required
    - `snippets` SnippetItem[], required: Integration snippets, one per supported target platform
      - `framework` 'HTML' | 'PlaceHolder', required: Target platform for the snippet. `HTML` is the browser script tag; `PlaceHolder` is reserved for future native SDK targets.
      - `snippet` string, required: Drop-in integration snippet pre-configured with the tenant's `app_id` and collector endpoint
    - `tenant_name` string, required: Tenant slug returned as tenant_name for compatibility
    - `app_id` string, required: Clickstream application identifier embedded in the snippet (format: `<tenant_slug>_<32-char-hex>`)
    - `tenant_id` string, uuid, required: Tenant identifier sent as `globalAttributes.tenant_id` on every clickstream event

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found
- `422`: Request Validation Failed
- `500`: Internal Server Error

---

[API](https://skmtc.dev/urbanfox/apis/urbanfox-customer-api.md) - [All operations](https://skmtc.dev/urbanfox/apis/urbanfox-customer-api/llms.txt) - [OpenAPI document](https://skmtc.dev/urbanfox/apis/urbanfox-customer-api/revisions/2850fb315db8?raw)