List organisations

GEThttps://app.speybooks.com/api/v1/admin/orgs

A paginated list of all organisations with subscription details and usage counts.

Filters

  • search: partial match on name or slug
  • plan: all (default), trial, sole_trader, limited_company
  • status: all (default), any subscription status verbatim (trialing, active, past_due, canceled, unpaid, incomplete, incomplete_expired, paused), or never_subscribed for organisations in or past their cardless grace window

Each organisation carries an aggregated user count and invoice count.

Response

200Paginated organisation list with Stripe details, user/invoice counts, and trial status.
Show response fields
organisationsarray<object>
Show child attributes
createdAtstringdate-time
idstring
invoiceCountinteger
namestring
planstring
slugstring
stripeCustomerIdstring
subscriptionStatusstring
trialEndsAtstringdate-time
userCountinteger