Skip to main content
GET
List organization switch options

Response

Returns the list of organization switch option.

id
string

The unique ID for this organization switch option.

name
string

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

role
enum<string>

The role value for this organization switch option.

Available options:
Owner,
Admin,
Agent
isCurrent
boolean

Whether this organization switch option is current.

lastUsedAt
string<date-time> | null

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

organizationStatus
enum<string> | null

Defines the supported Organization 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
tenDlcStatus
enum<string> | null

Defines the supported 10DLC Application Status values.

Available options:
NotStarted,
DraftGenerated,
DraftIncomplete,
ReadyToSubmit,
Submitted,
PendingTelnyxReview,
Approved,
Rejected,
NeedsChanges,
ResubmissionReady,
Failed
needsAdminReview
boolean

Whether needs admin review applies to this organization switch option.

activationSummary
string | null

The activation summary value for this organization switch option.

hasPaymentMethod
boolean

Whether the organization has a default billing payment method.

readyForCustomerTraffic
boolean

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