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

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

const response = await client.organizations.listOrganizations({
  query: {},
})
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "billingEmail": "<string>",
      "onboardingData": {
        "version": 1,
        "completedSteps": [],
        "organizationProfile": {
          "displayName": "<string>"
        },
        "workspaceProfile": {
          "teamName": "<string>",
          "website": "<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>",
  "pageOffset": 123
}

Authorizations

Authorization
string
header
required

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

Query Parameters

cursor
string

Opaque pagination cursor from the previous page response (nextCursor/prevCursor); omit to start at the first page.

offset
string

Zero-based row offset to jump to (numbered pages), 0 to 10000. With a cursor, the jump starts from that cursor; without one it is a plain offset. Lists not yet on the signed cursor standard ignore it.

Examples:

"0"

"25"

limit
string
default:25

Page size as a positive integer string; defaults to 25, capped at 100.

Examples:

"25"

"100"

sortBy
string

Field to sort by; each endpoint accepts its own allowlist and defaults to createdAt.

Example:

"createdAt"

sortOrder
enum<string>
default:desc

Sort direction: asc or desc; defaults to desc.

Available options:
asc,
desc

Response

Success

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

Opaque cursor for the page after this one; null on the last page.

prevCursor
string | null
required

Opaque cursor for the page before this one; null on the first page. Lists on the signed cursor standard return a real backwards cursor; older lists echo the request cursor.

pageOffset
number | null

Zero-based position of the first row of this page within total (for "Showing 26-50 of 268" and page numbers); null when unknown.