Overview
The Get Organisation endpoint returns the authenticated organisation’s profile and subscription information. Use this to display account details, verify subscription status, or check team size.Authentication
Requires a valid API key. No special permission scope is needed beyond a valid key.Key Features
- Subscription Info: Current plan, status, and billing period end date
- Team Details: Member count and organisation metadata
- No Credit Cost: This endpoint is free to use
Example Response
Response Fields
| Field | Type | Description |
|---|---|---|
id | string | Unique organisation identifier |
user_id | string | Owner user identifier |
name | string | Organisation display name |
slug | string | URL-safe organisation slug |
website | string | null | Organisation website URL |
subscription.plan | string | Current plan: FREE, PRO, ENTERPRISE, or CUSTOM |
subscription.status | string | Subscription status: ACTIVE, INACTIVE, PAST_DUE, or CANCELLED |
subscription.current_period_end | string | ISO 8601 date when the current billing period ends |
member_count | integer | Number of members in the organisation |
created | string | ISO 8601 date when the organisation was created |
Credit Usage
This endpoint is free and does not consume credits.Related Endpoints
- Get Credit Balance to check your available credits
- Get Usage Summary to review overall resource consumption