Skip to main content
GET
/
businesses
/
me
/
options
List business switch options for current user
curl --request GET \
  --url https://api.leadping.ai/businesses/me/options
[
  {
    "id": "<string>",
    "name": "<string>",
    "isCurrent": true,
    "lastUsedAt": "2023-11-07T05:31:56Z",
    "needsAdminReview": true,
    "activationSummary": "<string>",
    "readyForCustomerTraffic": true
  }
]

Response

200 - application/json

Returns the list of business switch option.

​
id
string

The unique ID for this business switch option.

​
name
string

The human-readable name shown for this business switch option.

​
role
enum<string>

The role value for this business switch option.

Available options:
Owner,
Admin,
Agent
​
isCurrent
boolean

Whether this business switch option is current.

​
lastUsedAt
string<date-time> | null

The date and time for the last used at value on this business switch option.

​
businessStatus
enum<string> | null

Defines the supported Business Status values.

Available options:
SettingUp,
SetupCompleted,
Active
​
activationStatus
enum<string> | null

Defines the supported Customer Activation Status values.

Available options:
DraftOnboarding,
PaymentMethodPending,
PaymentMethodConfirmed,
SubscriptionPending,
SubscriptionReceived,
SubscriptionActive,
LaunchReviewPending,
TelephonyProvisioningPending,
TelephonyPartiallyProvisioned,
TelephonyReady,
AwaitingReview,
DomainSelection,
WebsiteSetup,
ComplianceRegistration,
ReadyForApproval,
Active,
Failed,
Blocked,
BlockedRequiresOperatorAction,
ManuallyBypassed
​
needsAdminReview
boolean

Whether needs admin review applies to this business switch option.

​
activationSummary
string | null

The activation summary value for this business switch option.

​
readyForCustomerTraffic
boolean

Whether ready for customer traffic applies to this business switch option.