API Documentation
Chatbot Appearance
Chatbot Custom Content
Chatbot Follow Up Prompts
Chatbot Icons
Chatbot Links
Chatbot Messages
Chatbot Personas
Chatbot Prompts
Chatbot Quick Prompts
Chatbot Settings
Chatbot Threads
Fetch Whitelabel User
Fetch an user of your whitelabel brand.
Pre-requisities:
- You have to be a whitelabel customer in SiteGPT.
- You need to create and configure your own brand in SiteGPT dashboard.
curl --request GET \
--url https://sitegpt.ai/api/v0/w/brands/{brandId}/users/{userId} \
--header 'Authorization: Bearer <token>'
{
"success": true,
"message": "Fetched the whitelabel user successfully",
"data": {
"whitelabelUser": {
"id": "401577831134278614",
"brandId": "401537586571228250",
"email": "dheeraj@sitegpt.ai",
"name": "",
"profilePic": "",
"chatbotsQuota": 1,
"linksQuota": 25,
"filesQuota": 10,
"combinedMessagesQuota": 25,
"membersQuota": 1,
"apiKey": "7f488a50-8a5a-9e34-9a04-1dad5bd548c3",
"features": {
"watermark": false,
"api": true,
"webhooks": false,
"functions": false,
"integrations": false,
"googleChatIntegration": false,
"messengerChatIntegration": false,
"crispChatIntegration": false,
"slackChatIntegration": false,
"zendeskChatIntegration": false
},
"createdAt": "2024-06-24T11:38:34.228989Z",
"updatedAt": "2024-06-27T13:42:38.046991Z"
}
}
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
Id of the whitelabel user
Id of the whitelabel brand
Query Parameters
Option to decide whether to include API key in the response or not
Option to decide whether to include features in the response or not
Response
Indicates whether this is success response or error response
Overall message regarding the operation performed
Data returned from the server
Whitelabel User
Id of the whitelabel user
Id of the brand which whitelabel user belongs to
Email of the whitelabel user
Name of the whitelabel user
Profile picture url of the whitelabel user
Chatbots quota of the whitelabel user
Links quota of the whitelabel user
Files quota of the whitelabel user
Messages quota of the whitelabel user
Members quota of the whitelabel user
API key of the whitelabel user
Features of Whitelabel User
Indicates whether the watermark feature is enabled or not
Indicates whether the api feature is enabled or not
Indicates whether the webhooks feature is enabled or not
Indicates whether the functions feature is enabled or not
Indicates whether the integrations feature is enabled or not
Indicates whether the google chat feature is enabled or not
Indicates whether the messenger chat feature is enabled or not
Indicates whether the crisp chat feature is enabled or not
Indicates whether the slack chat feature is enabled or not
Indicates whether the zendesk chat feature is enabled or not
Timestamp at which the whitelabel user has been created
Timestamp at which the whitelabel user has been recently updated
Was this page helpful?
curl --request GET \
--url https://sitegpt.ai/api/v0/w/brands/{brandId}/users/{userId} \
--header 'Authorization: Bearer <token>'
{
"success": true,
"message": "Fetched the whitelabel user successfully",
"data": {
"whitelabelUser": {
"id": "401577831134278614",
"brandId": "401537586571228250",
"email": "dheeraj@sitegpt.ai",
"name": "",
"profilePic": "",
"chatbotsQuota": 1,
"linksQuota": 25,
"filesQuota": 10,
"combinedMessagesQuota": 25,
"membersQuota": 1,
"apiKey": "7f488a50-8a5a-9e34-9a04-1dad5bd548c3",
"features": {
"watermark": false,
"api": true,
"webhooks": false,
"functions": false,
"integrations": false,
"googleChatIntegration": false,
"messengerChatIntegration": false,
"crispChatIntegration": false,
"slackChatIntegration": false,
"zendeskChatIntegration": false
},
"createdAt": "2024-06-24T11:38:34.228989Z",
"updatedAt": "2024-06-27T13:42:38.046991Z"
}
}
}