---
title: "Get tenant"
method: GET
path: "/v2/{tenant_slug}/tenants"
tags: ["Tenants"]
---

# Get tenant

`GET /v2/{tenant_slug}/tenants`

## Request

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

Retrieve tenant identifiers and integration configuration.

## Path parameters

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

## Response `200`

Successful Response

- APIResponseTenantDetailsResponse
  - `data` TenantDetailsResponse, required
    - `tenant_name` string, required: Unique tenant slug returned as tenant_name for compatibility (e.g. `/v2/{tenant_slug}/...`)
    - `tenant_id` string, uuid, required: Stable UUID identifier for the tenant, embedded in JWT claims and downstream services
    - `client_id` string, required: OAuth 2.0 client identifier. Send this value as `client_id` when requesting a token from `POST /v2/oauth/token`.
    - `clickstream_app_id` string, nullable: Clickstream application identifier injected into the tracking snippet (format: `<tenant_slug>_<32-char-hex>`); null until provisioned
    - `created_at` string, date-time, nullable: Time the tenant record was created (RFC 3339 / ISO 8601 UTC); null for tenants created before this field was tracked

## 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)