Tenants

Get tenant

Retrieve tenant identifiers and integration configuration.

get/v2/{tenant_slug}/tenants

Request

Base URL
https://api.demo-retail.urbanfox.io
Auth
OAuth 2
Client credentials
Token URLhttps://api.demo-retail.urbanfox.io/v2/oauth/token
Scopesread: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.

Path parameters

tenant_slugstring required

Tenant DNS slug (lowercase letters, digits, and hyphens; 3-100 characters).

Example:demo-retail

Response

Successful Response

Example response

{
  "data": {
    "tenant_name": "demo-retail",
    "tenant_id": "00000000-0000-4000-8000-000000000000",
    "client_id": "A1b2C3d4E5f6G7h8I9j0K1l2M3n4O5p6",
    "clickstream_app_id": "demo-retail_00000000000000000000000000000001",
    "created_at": "2026-03-10T14:32:00Z"
  }
}

Changes

No recorded changes to this operation across all 8 revisions of this API.