curl --request GET \
--url https://api.embedreach.com/partner/tenants/{id}{
"success": true,
"message": "<string>",
"data": {
"id": "<string>",
"name": "<string>",
"website": "<string>",
"externalId": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"locations": [
{
"addressLine1": "<string>",
"locality": "<string>",
"district": "<string>",
"postalCode": "<string>",
"countryCode": "<string>",
"addressLine2": "<string>",
"addressLine3": "<string>"
}
],
"branding": {
"logoBase64": "<string>",
"logoURL": "<string>",
"primaryColor": "<string>",
"secondaryColors": [
"<string>"
],
"brandName": "<string>",
"primaryPhone": "<string>",
"primaryEmail": "[email protected]",
"brandTagline": "<string>",
"brandPersonality": {
"tone": "<string>",
"voice": "<string>",
"values": [
"<string>"
]
},
"colorPalette": {
"primary": "<string>",
"secondary": [
"<string>"
],
"accent": [
"<string>"
],
"background": [
"<string>"
],
"text": [
"<string>"
]
}
},
"deletedAt": "<string>",
"dataIntegrationCompletedAt": "<string>",
"websiteTrackingCompletedAt": "<string>",
"uiDefaults": {
"emailHelpDialogShow": false,
"engageOnboardingShow": true
},
"smsOptInImageUrls": [
"<string>"
]
}
}Get a tenant by id or external id
curl --request GET \
--url https://api.embedreach.com/partner/tenants/{id}{
"success": true,
"message": "<string>",
"data": {
"id": "<string>",
"name": "<string>",
"website": "<string>",
"externalId": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"locations": [
{
"addressLine1": "<string>",
"locality": "<string>",
"district": "<string>",
"postalCode": "<string>",
"countryCode": "<string>",
"addressLine2": "<string>",
"addressLine3": "<string>"
}
],
"branding": {
"logoBase64": "<string>",
"logoURL": "<string>",
"primaryColor": "<string>",
"secondaryColors": [
"<string>"
],
"brandName": "<string>",
"primaryPhone": "<string>",
"primaryEmail": "[email protected]",
"brandTagline": "<string>",
"brandPersonality": {
"tone": "<string>",
"voice": "<string>",
"values": [
"<string>"
]
},
"colorPalette": {
"primary": "<string>",
"secondary": [
"<string>"
],
"accent": [
"<string>"
],
"background": [
"<string>"
],
"text": [
"<string>"
]
}
},
"deletedAt": "<string>",
"dataIntegrationCompletedAt": "<string>",
"websiteTrackingCompletedAt": "<string>",
"uiDefaults": {
"emailHelpDialogShow": false,
"engageOnboardingShow": true
},
"smsOptInImageUrls": [
"<string>"
]
}
}Whether to include deactivated tenants in the results.
Status 200 response
Show child attributes
The id of the business
A friendly name for the business
The website of the business
The external id of the business
The date and time the business was created
The date and time the business was last updated
The locations of the business
Show child attributes
The city or town of the business (e.g. New York)
The State (e.g. NY, CA, etc.) of the business
The postal code of the business
The country code of the business (e.g. USA)
The branding of the business
Show child attributes
Base64 encoded logo image. We recommend 128px x 128px for best results. (either this or logoURL)
Absolute URL for the brand logo. We recommend 128px x 128px for best results. (either this or logoBase64)
The primary color of the business.
Secondary brand colors.
The name of the brand.
The primary phone of the business.
The primary email of the business.
The brand tagline or slogan.
Brand color palette.
Show child attributes
Primary color.
Secondary colors.
Accent colors.
Background colors.
Text colors.
The date and time the business was deactivated
The date and time the business completed data integration
The date and time the business completed website tracking configuration
Business-specific UI defaults for dialogs and feature toggles
Array of URLs that demonstrate how SMS consent is obtained. Can be image URLs (screenshots) or URLs to ordering/checkout pages where consent is captured.