🔗 Console REST APIOrganization
Get organization details
Retrieves details of the current organization
GET
header
Authorization<token>API Key is required to access the endpoints
Successfully retrieved organization details
- response
id?stringFormat
uuidstripeId?string|nullname?string|nullcompany?string|nullcountry?string|nulladdress1?string|nulladdress2?string|nullcity?string|nullpostalCode?string|nullregion?string|nullpurchaseOrder?string|nullbillingEmail?string|nullautoRechargeEnabled?integerFormat
int32autoRechargeBalanceGoesBelowUsd?integerFormat
int32autoRechargeBalanceBackUpToUsd?integerFormat
int32creditBalance?integerFormat
int32creditUninvoicedCurrent?integerFormat
int32creditUninvoicedLimit?integerFormat
int32creditUsageYesterday?integerFormat
int32creditUsageToday?integerFormat
int32creditUsageTodayUpdatedAt?|Format
date-timepastDueUsd?integerFormat
int32pastDueSince?|Format
date-timeapiKeysActiveCount?integerFormat
int32ticketsLiveWaitOnProvider?integerFormat
int32ticketsLiveWaitOnCustomer?integerFormat
int32ticketsNotLive?integerFormat
int32totalPaidUsd?integerFormat
int32totalPaidUsdLastW?integerFormat
int32totalPaidUsdLastM?integerFormat
int32totalPaidUsdLastQ?integerFormat
int32totalPaidUsdLastY?integerFormat
int32tier?string|nulllifetimeValueTier?|Format
int32lifetimeValueNextTierUsdCents?|Format
int64firstPaymentDate?|Format
date-timelastAuditTrailEvent?|Format
date-timeusageInvoicedUpToExcl?|Format
date-timepaymentMethodsLiveCount?integerFormat
int32quotaThresholdLastNotification?|Format
date-timequotaExceededLastNotification?|Format
date-timeallNotificationsEmail?string|nullactionRequiredNotificationsEmail?string|nullcreditsLowBalanceLastNotification?|Format
date-timetimeCreated?stringFormat
date-timeteamMembersCount?integerFormat
int32spendMgmtEnabled?integerFormat
int32spendMgmtCreditUsageDailyHardLimit?|Format
int32spendMgmtCreditUsageDailyNotifyThreshold?|Format
int32spendMgmtCreditUsageWebhookUrl?string|nullspendMgmtNotifyLimitLastNotification?|Format
date-timespendMgmtHardLimitLastNotification?|Format
date-timeslackChannelRequestedTime?|Format
date-timestatus?string|nullstatusChangedTime?stringFormat
date-timestatusSuspendedReason?string|nullbillingMode?string|nullcustomReferralCode?|Length
0 <= length <= 32creatingConsoleLoginId?|Format
uuidstripeConnectAccountId?|Length
0 <= length <= 64referralPayoutMethod?|Length
0 <= length <= 32stripeConnectReleasedUtc?|Format
date-timecurl -X GET 'https://api-console.apibricks.io/api/organization'{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "stripeId": "string", "name": "string", "company": "string", "country": "string", "address1": "string", "address2": "string", "city": "string", "postalCode": "string", "region": "string", "purchaseOrder": "string", "billingEmail": "string", "autoRechargeEnabled": 0, "autoRechargeBalanceGoesBelowUsd": 0, "autoRechargeBalanceBackUpToUsd": 0, "creditBalance": 0, "creditUninvoicedCurrent": 0, "creditUninvoicedLimit": 0, "creditUsageYesterday": 0, "creditUsageToday": 0, "creditUsageTodayUpdatedAt": "2019-08-24T14:15:22Z", "pastDueUsd": 0, "pastDueSince": "2019-08-24T14:15:22Z", "apiKeysActiveCount": 0, "ticketsLiveWaitOnProvider": 0, "ticketsLiveWaitOnCustomer": 0, "ticketsNotLive": 0, "totalPaidUsd": 0, "totalPaidUsdLastW": 0, "totalPaidUsdLastM": 0, "totalPaidUsdLastQ": 0, "totalPaidUsdLastY": 0, "tier": "string", "lifetimeValueTier": 0, "lifetimeValueNextTierUsdCents": 0, "firstPaymentDate": "2019-08-24T14:15:22Z", "lastAuditTrailEvent": "2019-08-24T14:15:22Z", "usageInvoicedUpToExcl": "2019-08-24T14:15:22Z", "paymentMethodsLiveCount": 0, "quotaThresholdLastNotification": "2019-08-24T14:15:22Z", "quotaExceededLastNotification": "2019-08-24T14:15:22Z", "allNotificationsEmail": "string", "actionRequiredNotificationsEmail": "string", "creditsLowBalanceLastNotification": "2019-08-24T14:15:22Z", "timeCreated": "2019-08-24T14:15:22Z", "teamMembersCount": 0, "spendMgmtEnabled": 0, "spendMgmtCreditUsageDailyHardLimit": 0, "spendMgmtCreditUsageDailyNotifyThreshold": 0, "spendMgmtCreditUsageWebhookUrl": "string", "spendMgmtNotifyLimitLastNotification": "2019-08-24T14:15:22Z", "spendMgmtHardLimitLastNotification": "2019-08-24T14:15:22Z", "slackChannelRequestedTime": "2019-08-24T14:15:22Z", "status": "string", "statusChangedTime": "2019-08-24T14:15:22Z", "statusSuspendedReason": "string", "billingMode": "string", "customReferralCode": "string", "creatingConsoleLoginId": "7f89452b-58d1-48d0-aa99-f05e613e9699", "stripeConnectAccountId": "string", "referralPayoutMethod": "string", "stripeConnectReleasedUtc": "2019-08-24T14:15:22Z"}