Skip to main content
GET
/
partner
/
tenants
/
{id}
Get Tenant
curl --request GET \
  --url https://api.embedreach.com/partner/tenants/{id}
{
  "success": true,
  "message": "<string>",
  "data": {
    "id": "<string>",
    "name": "<string>",
    "website": "<string>",
    "externalId": "<string>",
    "locations": [
      {
        "addressLine1": "<string>",
        "addressLine2": "<string>",
        "addressLine3": "<string>",
        "locality": "<string>",
        "district": "<string>",
        "postalCode": "<string>",
        "countryCode": "<string>"
      }
    ],
    "branding": {
      "logoBase64": "<string>",
      "logoURL": "<string>",
      "primaryColor": "<string>",
      "secondaryColors": [
        "<string>"
      ],
      "brandName": "<string>",
      "brandTagline": "<string>",
      "brandPersonality": {
        "tone": "<string>",
        "voice": "<string>",
        "values": [
          "<string>"
        ]
      },
      "colorPalette": {
        "primary": "<string>",
        "secondary": [
          "<string>"
        ],
        "accent": [
          "<string>"
        ],
        "background": [
          "<string>"
        ],
        "text": [
          "<string>"
        ]
      }
    },
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "deletedAt": "<string>",
    "dataIntegrationCompletedAt": "<string>",
    "websiteTrackingCompletedAt": "<string>",
    "uiDefaults": {
      "emailHelpDialogShow": false,
      "engageOnboardingShow": true
    }
  }
}

Query Parameters

includeDeleted
boolean | null

Whether to include deactivated tenants in the results.

Response

Status 200 response

success
boolean
required
message
string
data
object