- Getting Started
- PATCHUpdate Chatbot Appearance
- POSTModify Chatbot Custom Content
- GETFetch All Follow Up Prompts
- POSTAdd Follow Up Prompt
- GETFetch Follow Up Prompt
- DELDelete Follow Up Prompt
- PATCHUpdate Follow Up Prompt
- GETFetch All Quick Prompts
- POSTAdd Quick Prompt
- GETFetch Quick Prompt
- DELDelete Quick Prompt
- PATCHUpdate Quick Prompt
- PATCHUpdate Chatbot Settings - Advanced
- PATCHUpdate Chatbot Settings - Chat Mode
- PATCHUpdate Chatbot Settings - General
- PATCHUpdate Chatbot Settings - Localization
- PATCHUpdate Chatbot Settings - User Data
API Documentation
Chatbot Appearance
Chatbot Custom Content
Chatbot Follow Up Prompts
Chatbot Quick Prompts
Chatbot Settings
Fetch Whitelabel Brands
Fetch all of your whitelabel brands
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
curl --request GET \
--url https://sitegpt.ai/api/v0/w/brands \
--header 'Authorization: Bearer <token>'
{
"success": "string",
"message": "string",
"data": {
"brands": [
{
"id": "38591051554671453681",
"name": "PSDK",
"domain": "app.brand.com",
"marketingDomain": "brand.com",
"supportEmail": "support@brand.com",
"color": "#000000",
"createdAt": "2024-01-03T14:23:17.043394Z",
"updatedAt": "2024-01-09T10:52:53.631589Z",
"metaDetails": {
"title": "Number One brand",
"description": "Number One brand for everything",
"ogImage": "https://sitegpt.ai/cdn-cgi/imagedelivery/AIHFDBHjnhbc/vcedv443r-cr5t-3rf5-d863-dckljdcdkc3/square"
},
"terms": "https://brand.com/terms",
"privacyPolicy": "https://brand.com/privacy",
"ownedById": "360596271623302134",
"logo": "https://sitegpt.ai/cdn-cgi/imagedelivery/hQTLE0NTlcNyb_tOYFnnyA/8d988e1f-2ea1-4b38-2d5d-1fc812560400/square",
"fullLogo": "https://sitegpt.ai/cdn-cgi/imagedelivery/hQTLE0NTlcNyb_tOYFnnyA/85052523-9a79-4dd8-f7d3-60a53175ef00/square",
"emailSettings": {
"resendApiKey": "rs_api_12e2e2cvwev",
"fromName": "Brand",
"fromEmail": "login@resend.app.brand.com",
"replyToEmail": "support@brand.com"
},
"defaultQuota": {
"chatbotsQuota": 1,
"linksQuota": 10,
"filesQuota": 5,
"combinedMessagesQuota": 20,
"membersQuota": 1
}
}
]
}
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Response
Indicates whether this is success response or error response
Overall message regarding the operation performed
Data returned from the server
Id of the whitelabel brand
Name of the whitelabel brand
Domain of the whitelabel brand
Marketing domain of the whitelabel brand
Support email of the whitelabel brand
Color of the whitelabel brand
Terms and conditions of the whitelabel brand
Privacy policy of the whitelabel brand
Owner id of the whitelabel brand
Logo of the whitelabel brand
Full logo of the whitelabel brand
Meta details of the whitelabel brand
Meta title of the whitelabel brand
Meta description of the whitelabel brand
Og image of the whitelabel brand
Email settings of the whitelabel brand
From name of email config of the whitelabel brand
From email of email config of the whitelabel brand
Reply-to email of email config of the whitelabel brand email config
Resend API key of email config of the whitelabel brand
Default quota of the brand
Default chatbots quota for the new users
Default links quota for the new users
Default files quota for the new users
Default messages quota for the new users
Default members quota for the new users
Timestamp at which the brand has been created
Timestamp at which the brand has been recently updated
Was this page helpful?
curl --request GET \
--url https://sitegpt.ai/api/v0/w/brands \
--header 'Authorization: Bearer <token>'
{
"success": "string",
"message": "string",
"data": {
"brands": [
{
"id": "38591051554671453681",
"name": "PSDK",
"domain": "app.brand.com",
"marketingDomain": "brand.com",
"supportEmail": "support@brand.com",
"color": "#000000",
"createdAt": "2024-01-03T14:23:17.043394Z",
"updatedAt": "2024-01-09T10:52:53.631589Z",
"metaDetails": {
"title": "Number One brand",
"description": "Number One brand for everything",
"ogImage": "https://sitegpt.ai/cdn-cgi/imagedelivery/AIHFDBHjnhbc/vcedv443r-cr5t-3rf5-d863-dckljdcdkc3/square"
},
"terms": "https://brand.com/terms",
"privacyPolicy": "https://brand.com/privacy",
"ownedById": "360596271623302134",
"logo": "https://sitegpt.ai/cdn-cgi/imagedelivery/hQTLE0NTlcNyb_tOYFnnyA/8d988e1f-2ea1-4b38-2d5d-1fc812560400/square",
"fullLogo": "https://sitegpt.ai/cdn-cgi/imagedelivery/hQTLE0NTlcNyb_tOYFnnyA/85052523-9a79-4dd8-f7d3-60a53175ef00/square",
"emailSettings": {
"resendApiKey": "rs_api_12e2e2cvwev",
"fromName": "Brand",
"fromEmail": "login@resend.app.brand.com",
"replyToEmail": "support@brand.com"
},
"defaultQuota": {
"chatbotsQuota": 1,
"linksQuota": 10,
"filesQuota": 5,
"combinedMessagesQuota": 20,
"membersQuota": 1
}
}
]
}
}