Get Profile
Merchant
Get Profile
GET
Get Profile
Endpoint Overview
GEThttps://api.unibee.dev/merchant/get
Get Profile
Authorization
All UniBee Merchant API requests require authentication via API key.| Header | Required | Description |
|---|---|---|
Authorization | Yes | Bearer <your_api_key> |
Content-Type | Yes | application/json (for request body) |
Parameters
Path, query, and request body parameters are defined in the schema below. Use the interactive Try it panel to see the full request structure. Path, query, and request body parameters are defined in the schema below. Use the interactive Try it panel to see the full request structure.Request examples
cURL
Sandbox
Response
Success responses return a JSON envelope withcode, data, message, redirect, and requestId. code 0 indicates success.
| Field | Type | Description |
|---|---|---|
code | integer | Response code. 0 = success |
data | object | Response payload |
data.Currency | array | Currency List |
data.MemberRoles | array | The member role list’ |
data.TimeZone | array | TimeZone List |
data.analyticsHost | string | Analytics Host |
data.cloudFeatureAnalyticsEnabled | boolean | Analytics Feature Enabled For Cloud Version |
data.cname | string | CNAME value for merchant to configure |
data.cnameDomain | string | Merchant CNAME Domain |
data.defaultCurrency | string | Default Currency |
data.defaultEmailGateway | string | Default Email Gateway |
data.emailGateways | object | Email Gateway Map |
data.emailSender | object | |
data.env | string | System Env, em: daily|stage|local|prod |
data.exchangeRateApiKey | string | ExchangeRateApiKey |
data.gateways | array | Gateway List |
data.globalTOPTEnabled | boolean | GlobalTOPTEnabled |
data.globalUSVATConfig | object | |
data.isOwner | boolean | Check Member is Owner |
data.isProd | boolean | Check System Env Is Prod, true|false |
data.merchant | object | |
data.merchantMember | object | |
data.multiCurrencyConfigs | array | Merchant’s MultiCurrency Configs |
data.openApiHost | string | OpenApi Host |
data.openApiKey | string | OpenAPIKey |
data.quickBooksCompanyName | string | QuickBooksCompanyName |
data.quickBooksLastSyncError | string | QuickBooksLastSyncError |
data.quickBooksLastSynchronized | string | QuickBooksLastSynchronized |
data.segmentServerSideKey | string | SegmentServerSideKey |
data.segmentUserPortalKey | string | SegmentUserPortalKey |
data.sendGridKey | string | SendGridKey |
data.taxJarApiKeys | object | |
data.vatSenseKey | string | VatSenseKey |
message | string | Human-readable message |
requestId | string | Request ID for support |
Error handling
| HTTP status | Meaning |
|---|---|
| 400 | Bad request — invalid or missing parameters. Check message in the body. |
| 401 | Unauthorized — missing or invalid API key. |
| 404 | Not found — invalid path or resource. |
| 500 | Server error — retry with backoff. |
code in the response body is non-zero, check message for details. Use requestId when contacting support.
