Skip to main content
GET
Get widget display configuration

Authorizations

X-ARIS-API-Key
string
header
required

Query Parameters

brokerageId
string
required

The brokerage ID.

Response

Widget configuration object.

Widget display and behavior configuration for a brokerage.

primaryColor
string
Example:

"#1e3a8a"

secondaryColor
string
Example:

"#06b6d4"

logoUrl
string<uri> | null
brokerageName
string
Example:

"Acme Realty"

greetingMessage
string
Example:

"Hi! How can I help you find your perfect home today?"

buttonStyle
enum<string>
Available options:
rounded,
square,
pill
Example:

"rounded"

chatPosition
enum<string>
Available options:
bottom-right,
bottom-left
Example:

"bottom-right"

title
string
Example:

"Acme Realty Assistant"

subtitle
string
Example:

"here to find your next home"

buttonText
string
Example:

"Chat with AI"

avatarEnabled
boolean
Example:

false

avatarId
string | null
voiceId
string | null