List Tenants - Reach Marketing & Automation Documentation

List Tenants

curl --request GET \
  --url https://api.embedreach.com/partner/tenants

{
  "success": true,
  "message": "<string>",
  "data": {
    "results": [
      {
        "id": "<string>",
        "name": "<string>",
        "website": "<string>",
        "externalId": "<string>",
        "createdAt": "<string>",
        "updatedAt": "<string>",
        "userCount": 123,
        "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>"
        ]
      }
    ],
    "pagination": {
      "hasNextPage": true,
      "total": 123,
      "cursor": "<string>"
    }
  }
}

GET

partner

tenants

List Tenants

curl --request GET \
  --url https://api.embedreach.com/partner/tenants

{
  "success": true,
  "message": "<string>",
  "data": {
    "results": [
      {
        "id": "<string>",
        "name": "<string>",
        "website": "<string>",
        "externalId": "<string>",
        "createdAt": "<string>",
        "updatedAt": "<string>",
        "userCount": 123,
        "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>"
        ]
      }
    ],
    "pagination": {
      "hasNextPage": true,
      "total": 123,
      "cursor": "<string>"
    }
  }
}

Query Parameters

cursor

string

The cursor to start from

limit

number | null

The limit of items to return, default is 100

includeDeleted

boolean | null

Whether to include deactivated tenants in the results.

string

Search term to filter tenants by name, external ID, or website.

orderBy

enum<string>

Field to sort by.

Available options:

name,

created_at,

updated_at

orderDirection

enum<string>

Sort direction.

Available options:

asc,

desc

fields

string

Comma-separated list of fields to return. This reduces payload size and improves performance by only fetching requested data. Available fields: id, name, website, external_id, locations, branding, created_at, updated_at, deleted_at, data_integration_completed_at, website_tracking_completed_at, uiDefaults, userCount. Example: "id,name" to only return id and name. If not provided, all fields are returned.

Response

Status 200 response

success

boolean

required

message

string

data

object

Show child attributes

data.results

object[]

required

Show child attributes

data.results.id

string

required

The id of the business

data.results.name

string

required

A friendly name for the business

data.results.website

string | null

required

The website of the business

data.results.externalId

string | null

required

The external id of the business

data.results.createdAt

string | null

required

The date and time the business was created

data.results.updatedAt

string | null

required

The date and time the business was last updated

data.results.userCount

number

required

The number of users for this business

data.results.locations

object[] | null

The locations of the business

Show child attributes

data.results.locations.addressLine1

string

required

data.results.locations.locality

string

required

The city or town of the business (e.g. New York)

data.results.locations.district

string

required

The State (e.g. NY, CA, etc.) of the business

data.results.locations.postalCode

string

required

The postal code of the business

data.results.locations.countryCode

string

required

The country code of the business (e.g. USA)

data.results.locations.addressLine2

string

data.results.locations.addressLine3

string

data.results.branding

object

The branding of the business

Show child attributes

data.results.branding.logoBase64

string | null

Base64 encoded logo image. We recommend 128px x 128px for best results. (either this or logoURL)

data.results.branding.logoURL

string | null

Absolute URL for the brand logo. We recommend 128px x 128px for best results. (either this or logoBase64)

data.results.branding.primaryColor

string | null

The primary color of the business.

data.results.branding.secondaryColors

string[] | null

Secondary brand colors.

data.results.branding.brandName

string | null

The name of the brand.

data.results.branding.primaryPhone

string | null

The primary phone of the business.

data.results.branding.primaryEmail

string<email> | null

The primary email of the business.

data.results.branding.brandTagline

string | null

The brand tagline or slogan.

data.results.branding.brandPersonality

object

Brand personality details.

Show child attributes

data.results.branding.brandPersonality.tone

string | null

Brand tone.

data.results.branding.brandPersonality.voice

string | null

Brand voice.

data.results.branding.brandPersonality.values

string[] | null

Brand values.

data.results.branding.colorPalette

object

Brand color palette.

Show child attributes

data.results.branding.colorPalette.primary

string | null

Primary color.

data.results.branding.colorPalette.secondary

string[] | null

Secondary colors.

data.results.branding.colorPalette.accent

string[] | null

Accent colors.

data.results.branding.colorPalette.background

string[] | null

Background colors.

data.results.branding.colorPalette.text

string[] | null

Text colors.

data.results.deletedAt

string | null

The date and time the business was deactivated

data.results.dataIntegrationCompletedAt

string | null

The date and time the business completed data integration

data.results.websiteTrackingCompletedAt

string | null

The date and time the business completed website tracking configuration

data.results.uiDefaults

object

Business-specific UI defaults for dialogs and feature toggles

Show child attributes

data.results.uiDefaults.emailHelpDialogShow

boolean

default:false

Whether the email help dialog should be shown for this business

data.results.uiDefaults.engageOnboardingShow

boolean

default:true

Whether the onboarding engagement wizard should be shown for this business

data.results.smsOptInImageUrls

string<uri>[] | null

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.

data.pagination

object

required

Show child attributes

data.pagination.hasNextPage

boolean

required

data.pagination.total

number

required

data.pagination.cursor

string | null

Delete Tenant Get Tenant

⌘I

API Documentation

Query Parameters

Response