CRM

Retrieve all accounts.

Optionally filtered by segment (segmentUid) or search query (q).

get/api/v1/crm/accounts

Request

  • Base URL: https://go.outseta.com
  • URL: https://go.outseta.com/api/v1/crm/accounts
  • Auth: one of:
    • HTTP bearer
    • API key in header Authorization

Query parameters

segmentUidstring nullable

Accounts are filtered based on whether they are associated with the segment

qstring nullable

Partial match on account name or exact account Uid

limitinteger

Requested page size. The server caps it at 100, or 25 when requested fields expand child objects or require additional queries; metadata.limit reports the applied value. Use offset=1 for the second page.

offsetinteger

Zero-based page number, not a record offset. With limit=50, the second page is offset=1; offset=50 is page index 50 (records 2501-2550).

Response

Example response

{
  "metadata": {
    "limit": 0,
    "offset": 0,
    "total": 0
  },
  "items": [
    {
      "Uid": "string",
      "_objectType": "string",
      "Created": "string",
      "Updated": "string",
      "ActivityEventData": {},
      "SchemaLessData": {},
      "StripeId": "string",
      "IsLivemode": false,
      "Name": "string",
      "ClientIdentifier": "string",
      "Currency": "string",
      "InvoiceNotes": "string",
      "IsDemo": false,
      "BillingAddress": {},
      "MailingAddress": {},
      "AccountStage": 2,
      "PaymentInformation": {},
      "PersonAccount": [],
      "StripeDefaultPaymentMethodId": "string",
      "StripeInvoices": [],
      "StripePaymentMethods": [],
      "StripeSubscriptions": [],
      "Subscriptions": [],
      "Deals": [],
      "LastLoginDateTime": "string",
      "AccountSpecificPageUrl1": "string",
      "AccountSpecificPageUrl2": "string",
      "AccountSpecificPageUrl3": "string",
      "AccountSpecificPageUrl4": "string",
      "AccountSpecificPageUrl5": "string",
      "AccountSpecificPageUrl6": "string",
      "AccountSpecificPageUrl7": "string",
      "AccountSpecificPageUrl8": "string",
      "AccountSpecificPageUrl9": "string",
      "AccountSpecificPageUrl10": "string",
      "RewardFulReferralId": "string",
      "ToltReferralId": "string",
      "TaxIds": [],
      "TaxStatus": "string",
      "AccountStageLabel": "string",
      "CurrentStripeProducts": "string",
      "CurrentStripeProductInstances": [],
      "CurrentSubscription": {},
      "DomainName": "string",
      "TenantBillingSystem": 1,
      "HasLoggedIn": false,
      "LatestSubscription": {},
      "LifetimeRevenue": 0,
      "NextStripeInvoiceDate": "string",
      "Nonce": "string",
      "PrimaryContact": {},
      "PrimarySubscription": {},
      "PrimaryStripeSubscription": {},
      "RecaptchaToken": "string",
      "StripeCheckoutMetadata": {},
      "StripeNextInvoiceSequence": 0,
      "StripePrice": [],
      "StripePriceIds": "string",
      "StripePromotionCode": "string",
      "TaxId": "string",
      "TaxIdIsInvalid": false,
      "TaxIdType": "string",
      "WebflowSlug": "string"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.