Get Business Profile
GET {{URL}}/v1/settings/business/profile
Make a
GET
API call to the
/v1/settings/business/profile
endpoint to retrieve your business profile settings.
Response Fields
A successful response includes the profile object containing the following business profile data:
| Name | Description |
|---|---|
address
Type: String | The address of the business. Maximum of 256 characters . |
description
Type: String | The description of the business. Maximum of 256 characters . |
email
Type: String | The email address (in valid email format) to contact the business. Maximum of 128 characters . |
vertical
Type: String |
The industry of the business. The value must be one of the following:
The business vertical cannot be set back to an empty value after it is created. |
websites
Type: Array of Strings |
The URLs (including
http://
or
https://
) associated with the business (e.g., website, Facebook Page, Instagram). Maximum of
2
websites with a
maximum of 256 characters
.
|
HEADERS
| Key | Datatype | Required | Description |
| Authorization | string | | |
RESPONSES
status: OK
{"settings":{"business":{"profile":{"address":"\u003cBUSINESS-ADDRESS\u003e","description":"\u003cBUSINESS-DESC\u003e","email":"\u003cBUSINESS-EMAIL\u003e","vertical":"\u003cBUSINESS-INDUSTRY\u003e","websites":["website-1","website-2"]}}},"meta":{"api_status":"stable","version":"v2.45.1"}}