---
title: "Retrieve all email lists."
method: GET
path: "/api/v1/email/lists"
tags: ["Email"]
---

# Retrieve all email lists.

`GET /api/v1/email/lists`

## Request

- Base URL: `https://go.outseta.com`
- URL: `https://go.outseta.com/api/v1/email/lists`
- Auth: one of:
  - HTTP bearer
  - API key in header `Authorization`

## Query parameters

- `limit` integer
- `offset` integer

## Response `200`

- object
  - `metadata` CollectionMetadata
    - `limit` integer
    - `offset` integer
    - `total` integer
  - `items` EmailList[]
    - `Uid` string, nullable
    - `_objectType` string, nullable
    - `Created` string, date-time, required
    - `Updated` string, date-time, required
    - `ActivityEventData` unknown
    - `Name` string, required
    - `Description` string, nullable
    - `WelcomeSubject` string, nullable
    - `WelcomeBody` string, nullable
    - `WelcomeFromName` string, nullable
    - `WelcomeFromEmail` string, nullable
    - `RequiresDoubleOptIn` boolean
    - `IsInternal` boolean
    - `EmailListPerson` EmailListPerson[], nullable
      - `Uid` string, nullable
      - `_objectType` string, nullable
      - `Created` string, date-time, required
      - `Updated` string, date-time, required
      - `ActivityEventData` unknown
      - `EmailList` EmailList (recursive)
      - `Person` Person
        - `Uid` string, nullable
        - `_objectType` string, nullable
        - `Created` string, date-time, required
        - `Updated` string, date-time, required
        - `ActivityEventData` unknown
        - `SchemaLessData` object, nullable
        - `Email` string, email, nullable
        - `FirstName` string, nullable
        - `LastName` string, nullable
        - `MailingAddress` Address
          - `Uid` string, nullable
          - `_objectType` string, nullable
          - `Created` string, date-time, required
          - `Updated` string, date-time, required
          - `ActivityEventData` unknown
          - `AddressLine1` string, nullable
          - `AddressLine2` string, nullable
          - `AddressLine3` string, nullable
          - `City` string, nullable
          - `State` string, nullable
          - `PostalCode` string, nullable
          - `Country` string, nullable
          - `GeoLocation` string, nullable
        - `PasswordLastUpdated` string, date-time, nullable
        - `PasswordMustChange` boolean
        - `PhoneMobile` string, nullable
        - `PhoneWork` string, nullable
        - `ProfileImageS3Url` string, nullable
        - `Title` string, nullable
        - `Timezone` string, nullable
        - `Language` string, nullable
        - `IPAddress` string, nullable
        - `Referer` string, nullable
        - `UserAgent` string, nullable
        - `LastLoginDateTime` string, date-time, nullable
        - `OAuthGoogleProfileId` string, nullable
        - `PersonAccount` PersonAccount[], nullable
          - `Uid` string, nullable
          - `_objectType` string, nullable
          - `Created` string, date-time, required
          - `Updated` string, date-time, required
          - `ActivityEventData` unknown
          - `Person` Person (recursive)
          - `Account` Account
            - `Uid` string, nullable
            - `_objectType` string, nullable
            - `Created` string, date-time, required
            - `Updated` string, date-time, required
            - `ActivityEventData` unknown
            - `SchemaLessData` object, nullable
            - `StripeId` string, nullable
            - `IsLivemode` boolean
            - `Name` string, required
            - `ClientIdentifier` string, nullable
            - `Currency` string, nullable
            - `InvoiceNotes` string, nullable
            - `IsDemo` boolean
            - `BillingAddress` Address
              - …
            - `MailingAddress` Address
              - …
            - `AccountStage` 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10: `2` - Trialing, `3` - Subscribing, `4` - Cancelling, `5` - Expired, `6` - Trial Expired, `7` - Past Due, `8` - Cancelling Trial, `9` - Paused, `10` - Created
            - `PaymentInformation` PaymentInformation
              - …
            - `PersonAccount` PersonAccount[], nullable
            - `StripeDefaultPaymentMethodId` string, nullable
            - `StripeInvoices` StripeInvoice[], nullable
              - …
            - `StripePaymentMethods` StripePaymentMethod[], nullable
              - …
            - `StripeSubscriptions` StripeSubscription[], nullable
              - …
            - `Subscriptions` Subscription[], nullable
              - …
            - `Deals` Deal[], nullable
              - …
            - `LastLoginDateTime` string, date-time, nullable
            - `AccountSpecificPageUrl1` string, nullable
            - `AccountSpecificPageUrl2` string, nullable
            - `AccountSpecificPageUrl3` string, nullable
            - `AccountSpecificPageUrl4` string, nullable
            - `AccountSpecificPageUrl5` string, nullable
            - `AccountSpecificPageUrl6` string, nullable
            - `AccountSpecificPageUrl7` string, nullable
            - `AccountSpecificPageUrl8` string, nullable
            - `AccountSpecificPageUrl9` string, nullable
            - `AccountSpecificPageUrl10` string, nullable
            - `RewardFulReferralId` string, nullable
            - `ToltReferralId` string, nullable
            - `TaxIds` AccountTaxId[], nullable
              - …
            - `TaxStatus` string, nullable
            - `AccountStageLabel` string, nullable
            - `CurrentStripeProducts` string, nullable
            - `CurrentStripeProductInstances` StripeProduct[], nullable
              - …
            - `CurrentSubscription` Subscription
              - …
            - `DomainName` string, nullable
            - `TenantBillingSystem` 1 | 2: `1` - Outseta, `2` - Stripe
            - `HasLoggedIn` boolean
            - `LatestSubscription` Subscription
              - …
            - `LifetimeRevenue` number
            - `NextStripeInvoiceDate` string, date-time, nullable
            - `Nonce` string, nullable
            - `PrimaryContact` Person (recursive)
            - `PrimarySubscription` Subscription
              - …
            - `PrimaryStripeSubscription` StripeSubscription
              - …
            - `RecaptchaToken` string, nullable
            - `StripeCheckoutMetadata` object, nullable
            - `StripeNextInvoiceSequence` integer, nullable
            - `StripePrice` string[], nullable
            - `StripePriceIds` string, nullable
            - `StripePromotionCode` string, nullable
            - `TaxId` string, nullable
            - `TaxIdIsInvalid` boolean
            - `TaxIdType` string, nullable
            - `WebflowSlug` string, nullable
          - `IsPrimary` boolean
          - `ReceiveInvoices` boolean
          - `Role` 1 | 2 | 3: `1` - Admin, `2` - Member, `3` - Operator
        - `DealPeople` DealPerson[], nullable
          - `Uid` string, nullable
          - `_objectType` string, nullable
          - `Created` string, date-time, required
          - `Updated` string, date-time, required
          - `ActivityEventData` unknown
          - `Person` Person (recursive)
          - `Deal` Deal
            - `Uid` string, nullable
            - `_objectType` string, nullable
            - `Created` string, date-time, required
            - `Updated` string, date-time, required
            - `ActivityEventData` unknown
            - `SchemaLessData` object, nullable
            - `Name` string, required
            - `Amount` number, nullable
            - `DueDate` string, date-time, nullable
            - `AssignedToPersonClientIdentifier` string, nullable
            - `Weight` integer
            - `DealPipelineStage` DealPipelineStage
              - …
            - `Account` Account
              - …
            - `DealPeople` DealPerson[], nullable
            - `Contacts` string, nullable
            - `AccountId` integer
            - `Owner` Person (recursive)
            - `PipelineUid` string, nullable
        - `LeadFormSubmissions` LeadFormSubmission[], nullable
          - `Uid` string, nullable
          - `_objectType` string, nullable
          - `Created` string, date-time, required
          - `Updated` string, date-time, required
          - `ActivityEventData` unknown
          - `Person` Person, required (recursive)
          - `LeadForm` LeadForm, required
            - `Uid` string, nullable
            - `_objectType` string, nullable
            - `Created` string, date-time, required
            - `Updated` string, date-time, required
            - `ActivityEventData` unknown
            - `Name` string, nullable
            - `FieldConfigurationDataJSON` string, nullable
            - `ThankYouRedirectUrl` string, uri, nullable
            - `SubmissionCount` integer
            - `PipelineStageUid` string, nullable
            - `DealPipelineStage` DealPipelineStage
              - …
          - `RefererURL` string, nullable
          - `HasPendingFields` boolean
          - `Fields` LeadFormSubmissionField[], nullable
            - `SystemName` string, nullable
            - `Value` string, nullable
            - `Outcome` 'Written' | 'Unchanged' | 'Skipped': `Written` - Saved, `Unchanged` - Unchanged, `Skipped` - Not saved
            - `PersonValue` string, nullable
          - `RecaptchaToken` string, nullable
          - `RecaptchaSiteKey` string, nullable
        - `Account` Account
          - `Uid` string, nullable
          - `_objectType` string, nullable
          - `Created` string, date-time, required
          - `Updated` string, date-time, required
          - `ActivityEventData` unknown
          - `SchemaLessData` object, nullable
          - `StripeId` string, nullable
          - `IsLivemode` boolean
          - `Name` string, required
          - `ClientIdentifier` string, nullable
          - `Currency` string, nullable
          - `InvoiceNotes` string, nullable
          - `IsDemo` boolean
          - `BillingAddress` Address
            - `Uid` string, nullable
            - `_objectType` string, nullable
            - `Created` string, date-time, required
            - `Updated` string, date-time, required
            - `ActivityEventData` unknown
            - `AddressLine1` string, nullable
            - `AddressLine2` string, nullable
            - `AddressLine3` string, nullable
            - `City` string, nullable
            - `State` string, nullable
            - `PostalCode` string, nullable
            - `Country` string, nullable
            - `GeoLocation` string, nullable
          - `MailingAddress` Address
            - `Uid` string, nullable
            - `_objectType` string, nullable
            - `Created` string, date-time, required
            - `Updated` string, date-time, required
            - `ActivityEventData` unknown
            - `AddressLine1` string, nullable
            - `AddressLine2` string, nullable
            - `AddressLine3` string, nullable
            - `City` string, nullable
            - `State` string, nullable
            - `PostalCode` string, nullable
            - `Country` string, nullable
            - `GeoLocation` string, nullable
          - `AccountStage` 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10: `2` - Trialing, `3` - Subscribing, `4` - Cancelling, `5` - Expired, `6` - Trial Expired, `7` - Past Due, `8` - Cancelling Trial, `9` - Paused, `10` - Created
          - `PaymentInformation` PaymentInformation
            - `Uid` string, nullable
            - `_objectType` string, nullable
            - `Created` string, date-time, required
            - `Updated` string, date-time, required
            - `ActivityEventData` unknown
            - `Account` Account, required (recursive)
            - `CustomerToken` string, nullable
            - `LastFourDigits` string, nullable
            - `LatestFailureDateTime` string, date-time, nullable
            - `LatestFailureDescription` string, nullable
            - `LatestSuccessDateTime` string, date-time, nullable
            - `NumberOfFailures` integer, required
            - `PaymentClientSecret` string, nullable
            - `PaymentMethodType` string, nullable
            - `PaymentToken` string, nullable
            - `BankName` string, nullable
            - `BankAccountType` string, nullable
            - `BankAccountHolderType` string, nullable
            - `NameOnCard` string, nullable
            - `CardType` string, nullable
            - `ExpirationMonth` string, nullable
            - `ExpirationYear` string, nullable
            - `Mode` string, nullable
            - `OneTimeToken` string, nullable
            - `RecaptchaToken` string, nullable
            - `SetupIntent` string, nullable
          - `PersonAccount` PersonAccount[], nullable
            - `Uid` string, nullable
            - `_objectType` string, nullable
            - `Created` string, date-time, required
            - `Updated` string, date-time, required
            - `ActivityEventData` unknown
            - `Person` Person (recursive)
            - `Account` Account (recursive)
            - `IsPrimary` boolean
            - `ReceiveInvoices` boolean
            - `Role` 1 | 2 | 3: `1` - Admin, `2` - Member, `3` - Operator
          - `StripeDefaultPaymentMethodId` string, nullable
          - `StripeInvoices` StripeInvoice[], nullable
            - `Uid` string, nullable
            - `_objectType` string, nullable
            - `Created` string, date-time, required
            - `Updated` string, date-time, required
            - `ActivityEventData` unknown
            - `SchemaLessData` object, nullable
            - `StripeId` string, nullable
            - `IsLivemode` boolean
            - `AmountDue` integer
            - `AmountPaid` integer
            - `AmountShipping` integer
            - `AttemptCount` integer
            - `Attempted` boolean
            - `Currency` string, nullable
            - `Description` string, nullable
            - `FinalizedAt` string, date-time, nullable
            - `HostedInvoiceUrl` string, nullable
            - `InvoicePdf` string, nullable
            - `NextPaymentAttempt` string, date-time, nullable
            - `Number` string, nullable
            - `PeriodEnd` string, date-time
            - `PeriodStart` string, date-time
            - `Status` string, nullable
            - `StripeDiscounts` StripeDiscount[], nullable
              - …
            - `StripeInvoiceDiscountAmounts` StripeInvoiceDiscountAmount[], nullable
              - …
            - `StripeInvoiceLineItems` StripeInvoiceLineItem[], nullable
              - …
            - `StripeInvoicePayments` StripeInvoicePayment[], nullable
              - …
            - `SubTotal` integer
            - `SubTotalExcludingTax` integer, nullable
            - `SubscriptionId` string, nullable
            - `Tax` integer, nullable
            - `Total` integer
            - `TotalExcludingTax` integer, nullable
            - `Account` Account (recursive)
            - `IsImported` boolean
            - `IsRefunded` boolean
            - `CurrencyAmountCreditedPostPayment` number
            - `CurrencyAmountCreditedPrePayment` number
            - `CurrencyAmountDue` number
            - `CurrencyAmountPaid` number
            - `CurrencySymbol` string, nullable
            - `CurrencyTotal` number
            - `CurrencyTotalExcludingTax` number
            - `CurrencySubTotal` number
            - `CurrencySubTotalExcludingTax` number
            - `CurrencyTax` number
            - `DaysUntilDue` integer, nullable
            - `CustomerId` string, nullable
            - `PaymentStatus` string, nullable
            - `StripeCreditNotes` StripeCreditNote[], nullable
              - …
            - `StripePaymentMethodId` string, nullable
          - `StripePaymentMethods` StripePaymentMethod[], nullable
            - `Uid` string, nullable
            - `_objectType` string, nullable
            - `Created` string, date-time, required
            - `Updated` string, date-time, required
            - `ActivityEventData` unknown
            - `SchemaLessData` object, nullable
            - `StripeId` string, nullable
            - `IsLivemode` boolean
            - `Account` Account (recursive)
            - `Card_Brand` string, nullable
            - `Card_ExpMonth` integer, nullable
            - `Card_ExpYear` integer, nullable
            - `Card_Wallet_Type` string, nullable
            - `BankName` string, nullable
            - `Last4` string, nullable
            - `Type` string, nullable
            - `Label` string, nullable
          - `StripeSubscriptions` StripeSubscription[], nullable
            - `Uid` string, nullable
            - `_objectType` string, nullable
            - `Created` string, date-time, required
            - `Updated` string, date-time, required
            - `ActivityEventData` unknown
            - `SchemaLessData` object, nullable
            - `StripeId` string, nullable
            - `IsLivemode` boolean
            - `ApplicationFeePercent` number, nullable
            - `CancelAt` string, date-time, nullable
            - `CancelAtPeriodEnd` boolean
            - `StripeSubscriptionCancellation` StripeSubscriptionCancellation
              - …
            - `Currency` string, nullable
            - `EndedAt` string, date-time, nullable
            - `PauseCollection_Behavior` string, nullable
            - `PauseCollection_ResumesAt` string, date-time, nullable
            - `StartDate` string, date-time
            - `Status` string, nullable
            - `TrialEnd` string, date-time, nullable
            - `StripeDiscounts` StripeDiscount[], nullable
              - …
            - `StripeSubscriptionItems` StripeSubscriptionItem[], nullable
              - …
            - `StripeSubscriptionSchedules` StripeSubscriptionSchedule[], nullable
              - …
            - `Account` Account (recursive)
            - `AccountUid` string, nullable
            - `BillingCycleAnchor` string, date-time, nullable
            - `CollectionMethod` string, nullable
            - `CustomerId` string, nullable
            - `DaysUntilDue` integer, nullable
            - `ScheduleId` string, nullable
            - `StripeDiscountIds` string[], nullable
            - `StripePriceIds` string, nullable
            - `TrialPeriodDays` integer
            - `CurrentStripeSubscriptionSchedule` StripeSubscriptionSchedule
              - …
          - `Subscriptions` Subscription[], nullable
            - `Uid` string, nullable
            - `_objectType` string, nullable
            - `Created` string, date-time, required
            - `Updated` string, date-time, required
            - `ActivityEventData` unknown
            - `BillingRenewalTerm` 1 | 2 | 3 | 4: `1` - Monthly, `2` - Yearly, `3` - Quarterly, `4` - One Time
            - `Account` Account (recursive)
            - `Plan` Plan
              - …
            - `Quantity` integer, nullable
            - `StartDate` string, date-time
            - `EndDate` string, date-time, nullable
            - `ExpirationDate` string, date-time, nullable
            - `RenewalDate` string, date-time, nullable
            - `NewRequiredQuantity` integer, nullable
            - `IsPlanUpgradeRequired` boolean
            - `PlanUpgradeRequiredMessage` string, nullable
            - `SubscriptionAddOns` SubscriptionAddOn[], nullable
              - …
            - `DiscountCouponSubscriptions` DiscountCouponSubscription[], nullable
              - …
            - `DiscountCode` string, nullable
            - `DiscountCouponExpirationDate` string, date-time, nullable
            - `LatestInvoice` Invoice
              - …
            - `Rate` number, nullable
          - `Deals` Deal[], nullable
            - `Uid` string, nullable
            - `_objectType` string, nullable
            - `Created` string, date-time, required
            - `Updated` string, date-time, required
            - `ActivityEventData` unknown
            - `SchemaLessData` object, nullable
            - `Name` string, required
            - `Amount` number, nullable
            - `DueDate` string, date-time, nullable
            - `AssignedToPersonClientIdentifier` string, nullable
            - `Weight` integer
            - `DealPipelineStage` DealPipelineStage
              - …
            - `Account` Account (recursive)
            - `DealPeople` DealPerson[], nullable
              - …
            - `Contacts` string, nullable
            - `AccountId` integer
            - `Owner` Person (recursive)
            - `PipelineUid` string, nullable
          - `LastLoginDateTime` string, date-time, nullable
          - `AccountSpecificPageUrl1` string, nullable
          - `AccountSpecificPageUrl2` string, nullable
          - `AccountSpecificPageUrl3` string, nullable
          - `AccountSpecificPageUrl4` string, nullable
          - `AccountSpecificPageUrl5` string, nullable
          - `AccountSpecificPageUrl6` string, nullable
          - `AccountSpecificPageUrl7` string, nullable
          - `AccountSpecificPageUrl8` string, nullable
          - `AccountSpecificPageUrl9` string, nullable
          - `AccountSpecificPageUrl10` string, nullable
          - `RewardFulReferralId` string, nullable
          - `ToltReferralId` string, nullable
          - `TaxIds` AccountTaxId[], nullable
            - `Uid` string, nullable
            - `_objectType` string, nullable
            - `Created` string, date-time, required
            - `Updated` string, date-time, required
            - `ActivityEventData` unknown
            - `SchemaLessData` object, nullable
            - `StripeId` string, nullable
            - `IsLivemode` boolean
            - `Account` Account (recursive)
            - `TaxId` string, nullable
            - `TaxIdType` string, nullable
            - `IsInvalid` boolean
          - `TaxStatus` string, nullable
          - `AccountStageLabel` string, nullable
          - `CurrentStripeProducts` string, nullable
          - `CurrentStripeProductInstances` StripeProduct[], nullable
            - `Uid` string, nullable
            - `_objectType` string, nullable
            - `Created` string, date-time, required
            - `Updated` string, date-time, required
            - `ActivityEventData` unknown
            - `SchemaLessData` object, nullable
            - `StripeId` string, nullable
            - `IsLivemode` boolean
            - `Name` string, nullable
            - `DefaultPriceId` string, nullable
            - `Description` string, nullable
            - `IsActive` boolean
            - `TaxCodeId` string, nullable
            - `UnitLabel` string, nullable
            - `ContentGroups` ContentGroup[], nullable
              - …
            - `StripePrices` StripePrice[], nullable
              - …
            - `AccountRegistrationMode` 1 | 2: `1` - Individual, `2` - Team
            - `ExpiresAfterMonths` integer
            - `ExpirationDate` string, date-time, nullable
            - `IsPerUser` boolean
            - `IsQuantityEditable` boolean
            - `MaximumPeople` integer, nullable
            - `MigratedAddOnUid` string, nullable
            - `MigratedPlanUid` string, nullable
            - `MinimumQuantity` integer, nullable
            - `PostLoginPath` string, nullable
            - `PostPurchaseUrl` string, nullable
            - `RequirePaymentInformation` boolean
            - `StripeProductCrossSells` StripeProductCrossSell[], nullable
              - …
            - `TrialPeriodDays` integer
            - `TrialUntilDate` string, date-time, nullable
            - `CanDelete` boolean
            - `NumberOfPurchases` integer
            - `NumberOfSubscriptions` integer
            - `Quantity` integer, nullable
            - `StripeProductFamily` StripeProductFamily
              - …
          - `CurrentSubscription` Subscription
            - `Uid` string, nullable
            - `_objectType` string, nullable
            - `Created` string, date-time, required
            - `Updated` string, date-time, required
            - `ActivityEventData` unknown
            - `BillingRenewalTerm` 1 | 2 | 3 | 4: `1` - Monthly, `2` - Yearly, `3` - Quarterly, `4` - One Time
            - `Account` Account (recursive)
            - `Plan` Plan
              - …
            - `Quantity` integer, nullable
            - `StartDate` string, date-time
            - `EndDate` string, date-time, nullable
            - `ExpirationDate` string, date-time, nullable
            - `RenewalDate` string, date-time, nullable
            - `NewRequiredQuantity` integer, nullable
            - `IsPlanUpgradeRequired` boolean
            - `PlanUpgradeRequiredMessage` string, nullable
            - `SubscriptionAddOns` SubscriptionAddOn[], nullable
              - …
            - `DiscountCouponSubscriptions` DiscountCouponSubscription[], nullable
              - …
            - `DiscountCode` string, nullable
            - `DiscountCouponExpirationDate` string, date-time, nullable
            - `LatestInvoice` Invoice
              - …
            - `Rate` number, nullable
          - `DomainName` string, nullable
          - `TenantBillingSystem` 1 | 2: `1` - Outseta, `2` - Stripe
          - `HasLoggedIn` boolean
          - `LatestSubscription` Subscription
            - `Uid` string, nullable
            - `_objectType` string, nullable
            - `Created` string, date-time, required
            - `Updated` string, date-time, required
            - `ActivityEventData` unknown
            - `BillingRenewalTerm` 1 | 2 | 3 | 4: `1` - Monthly, `2` - Yearly, `3` - Quarterly, `4` - One Time
            - `Account` Account (recursive)
            - `Plan` Plan
              - …
            - `Quantity` integer, nullable
            - `StartDate` string, date-time
            - `EndDate` string, date-time, nullable
            - `ExpirationDate` string, date-time, nullable
            - `RenewalDate` string, date-time, nullable
            - `NewRequiredQuantity` integer, nullable
            - `IsPlanUpgradeRequired` boolean
            - `PlanUpgradeRequiredMessage` string, nullable
            - `SubscriptionAddOns` SubscriptionAddOn[], nullable
              - …
            - `DiscountCouponSubscriptions` DiscountCouponSubscription[], nullable
              - …
            - `DiscountCode` string, nullable
            - `DiscountCouponExpirationDate` string, date-time, nullable
            - `LatestInvoice` Invoice
              - …
            - `Rate` number, nullable
          - `LifetimeRevenue` number
          - `NextStripeInvoiceDate` string, date-time, nullable
          - `Nonce` string, nullable
          - `PrimaryContact` Person (recursive)
          - `PrimarySubscription` Subscription
            - `Uid` string, nullable
            - `_objectType` string, nullable
            - `Created` string, date-time, required
            - `Updated` string, date-time, required
            - `ActivityEventData` unknown
            - `BillingRenewalTerm` 1 | 2 | 3 | 4: `1` - Monthly, `2` - Yearly, `3` - Quarterly, `4` - One Time
            - `Account` Account (recursive)
            - `Plan` Plan
              - …
            - `Quantity` integer, nullable
            - `StartDate` string, date-time
            - `EndDate` string, date-time, nullable
            - `ExpirationDate` string, date-time, nullable
            - `RenewalDate` string, date-time, nullable
            - `NewRequiredQuantity` integer, nullable
            - `IsPlanUpgradeRequired` boolean
            - `PlanUpgradeRequiredMessage` string, nullable
            - `SubscriptionAddOns` SubscriptionAddOn[], nullable
              - …
            - `DiscountCouponSubscriptions` DiscountCouponSubscription[], nullable
              - …
            - `DiscountCode` string, nullable
            - `DiscountCouponExpirationDate` string, date-time, nullable
            - `LatestInvoice` Invoice
              - …
            - `Rate` number, nullable
          - `PrimaryStripeSubscription` StripeSubscription
            - `Uid` string, nullable
            - `_objectType` string, nullable
            - `Created` string, date-time, required
            - `Updated` string, date-time, required
            - `ActivityEventData` unknown
            - `SchemaLessData` object, nullable
            - `StripeId` string, nullable
            - `IsLivemode` boolean
            - `ApplicationFeePercent` number, nullable
            - `CancelAt` string, date-time, nullable
            - `CancelAtPeriodEnd` boolean
            - `StripeSubscriptionCancellation` StripeSubscriptionCancellation
              - …
            - `Currency` string, nullable
            - `EndedAt` string, date-time, nullable
            - `PauseCollection_Behavior` string, nullable
            - `PauseCollection_ResumesAt` string, date-time, nullable
            - `StartDate` string, date-time
            - `Status` string, nullable
            - `TrialEnd` string, date-time, nullable
            - `StripeDiscounts` StripeDiscount[], nullable
              - …
            - `StripeSubscriptionItems` StripeSubscriptionItem[], nullable
              - …
            - `StripeSubscriptionSchedules` StripeSubscriptionSchedule[], nullable
              - …
            - `Account` Account (recursive)
            - `AccountUid` string, nullable
            - `BillingCycleAnchor` string, date-time, nullable
            - `CollectionMethod` string, nullable
            - `CustomerId` string, nullable
            - `DaysUntilDue` integer, nullable
            - `ScheduleId` string, nullable
            - `StripeDiscountIds` string[], nullable
            - `StripePriceIds` string, nullable
            - `TrialPeriodDays` integer
            - `CurrentStripeSubscriptionSchedule` StripeSubscriptionSchedule
              - …
          - `RecaptchaToken` string, nullable
          - `StripeCheckoutMetadata` object, nullable
          - `StripeNextInvoiceSequence` integer, nullable
          - `StripePrice` string[], nullable
          - `StripePriceIds` string, nullable
          - `StripePromotionCode` string, nullable
          - `TaxId` string, nullable
          - `TaxIdIsInvalid` boolean
          - `TaxIdType` string, nullable
          - `WebflowSlug` string, nullable
        - `AccountUids` string, nullable
        - `EmailListPerson` EmailListPerson[], nullable
        - `FullName` string, nullable
        - `HasLoggedIn` boolean
        - `OAuthIntegrationStatus` 0 | 1: `0` - None, `1` - Gmail
        - `OptInToEmailList` boolean
        - `Password` string, nullable
        - `RecaptchaToken` string, nullable
        - `UserAgentPlatformBrowser` string, nullable
        - `HasUnsubscribed` boolean
        - `DiscordUser` DiscordUser
          - `Uid` string, nullable
          - `_objectType` string, nullable
          - `Created` string, date-time, required
          - `Updated` string, date-time, required
          - `ActivityEventData` unknown
          - `DiscordUserId` string, nullable
          - `DiscordEmail` string, nullable
          - `DiscordUsername` string, nullable
          - `DiscordOAuthRefreshToken` string, nullable
        - `IsConnectedToDiscord` boolean
      - `EmailListSubscriberStatus` 1 | 2 | 3 | 4: `1` - Subscribed, `2` - Unsubscribed, `3` - Cleaned, `4` - Confirmed
      - `SubscribedDate` string, date-time
      - `ConfirmedDate` string, date-time, nullable
      - `ConfirmationNotes` string, nullable
      - `UnsubscribedDate` string, date-time, nullable
      - `CleanedDate` string, date-time, nullable
      - `WelcomeEmailDeliverDateTime` string, date-time, nullable
      - `WelcomeEmailOpenDateTime` string, date-time, nullable
      - `UnsubscribeReason` string, nullable
      - `UnsubscribeReasonOther` string, nullable
      - `RecaptchaToken` string, nullable
      - `RecaptchaSiteKey` string, nullable
      - `SendWelcomeEmail` boolean
      - `Source` string, nullable
    - `FieldConfigurationDataJSON` string, nullable
    - `CountSubscriptionsActive` integer
    - `CountSubscriptionsBounce` integer
    - `CountSubscriptionsIssues` integer
    - `CountSubscriptionsNotConfirmed` integer
    - `CountSubscriptionsSpam` integer
    - `CountSubscriptionsUnsubscribed` integer

## Other responses

- `401`: Unauthorized

---

[API](https://skmtc.dev/outseta/apis/outseta-api.md) · [All operations](https://skmtc.dev/outseta/apis/outseta-api/llms.txt) · [OpenAPI document](https://skmtc.dev/outseta/apis/outseta-api/revisions/c362823af82d?raw)