Get organisation details

GET https://app.speybooks.com/api/v1/admin/orgs/{id}

Retrieve a 360-degree view of an organisation: full details, all linked users with roles, usage statistics (invoices, contacts, transactions), and the 20 most recent audit log entries scoped to that organisation.

Path parameters

id string required
Organisation ID.

Response

200 360-degree org view: subscription, users, usage stats, and recent audit activity.
Show response fields
organisation object
Show child attributes
id string
name string
plan string
slug string
stripeCustomerId string
stripeSubscriptionId string
subscriptionStatus string
recentActivity array<object>
stats object
Show child attributes
contacts integer
invoices integer
transactions integer
users array<object>
Show child attributes
email string
fullName string
id integer
isActive boolean
role string
totpEnabled boolean

Error codes

404 Organisation not found.