v1

latestOpenAPI 3.1.0MIT2026-07-2412028.8 KB
Tenants

Get an existing Redfast tenant

Retrieves an existing tenant from the Redfast platform.

get/v1/tenants/{external_tenant_id}

Path parameters

external_tenant_idstring required

Unique Partner Tenant ID

Query parameters

partner_codestring required

Partner Code assigned by Redfast

Headers

rf-secretstring required

Shared secret provided by Redfast (separate secrets for Test and Production)

Response

Tenant retrieved successfully

successboolean
external_tenant_idstring
app_idstring
tag_urlstring uri
user_first_namestring
user_last_namestring
user_emailstring email
app_namestring
company_namestring
app_domainstring
test_modeboolean

Example response

{
  "success": true,
  "external_tenant_id": "tenant-123",
  "app_id": "abc123app",
  "tag_url": "https://abc123app.redfastlabs.com/assets/redfast.js",
  "user_first_name": "John",
  "user_last_name": "Smith",
  "user_email": "jsmith@myemail.com",
  "app_name": "My App",
  "company_name": "My Company",
  "app_domain": "myco.com"
}