GET
/
v1
/
organizations
TypeScript client
import { OctosparkClient } from '@octospark/sdk'

const client = new OctosparkClient({
  token: process.env.OCTOSPARK_TOKEN
})

const response = await client.organizationsListOrganizations({
  query: {},
})
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "billingEmail": "<string>",
      "onboardingData": {
        "completedSteps": [],
        "organizationProfile": {
          "displayName": "<string>"
        },
        "workspaceProfile": {
          "teamName": "<string>",
          "website": "<string>",
          "brandSettings": {
            "colors": {
              "primary": "<string>",
              "secondary": "<string>",
              "accent": "<string>",
              "background": "<string>",
              "text": "<string>"
            },
            "brandGuidelines": "<string>",
            "industry": "<string>",
            "targetAudience": "<string>"
          }
        },
        "goals": {},
        "completedAt": "<string>"
      },
      "stripeCustomerId": "<string>",
      "stripeSubscriptionId": "<string>",
      "stripePaymentMethodId": "<string>",
      "stripeMeteredSubscriptionItemId": "<string>",
      "creditsBalance": 123,
      "reservedCredits": 123,
      "autoRechargeEnabled": true,
      "autoRechargeThreshold": 123,
      "autoRechargeAmount": 123,
      "isSubscribed": true,
      "subscriptionPlan": "<string>",
      "subscriptionStartedAt": "<string>",
      "subscriptionEndsAt": "<string>",
      "subscriptionCurrentPeriodEnd": "<string>",
      "createdAt": "<string>",
      "updatedAt": "<string>"
    }
  ],
  "total": 123,
  "nextCursor": "<string>",
  "prevCursor": "<string>"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

cursor
string
limit
string
sortBy
string
sortOrder
enum<string>
Available options:
asc,
desc

Response

Success

data
object[]
required
total
number
required
nextCursor
string | null
required
prevCursor
string | null
required