> ## Documentation Index > Fetch the complete documentation index at: https://docs.versori.com/llms.txt > Use this file to discover all available pages before exploring further. # Get Organisation > Get an Organisation by its ID ## OpenAPI ````yaml /openapi/organisations-api-v1.yaml get /organisations/{organisation_id} openapi: 3.1.0 info: title: Organisations API description: >- The Organisations API provides users the ability to manage their organisations. version: v1 servers: - url: https://platform.versori.com/api/organisations/v1 description: Production server - url: http://localhost:8081/v1 description: Localhost security: [] tags: - name: organisations description: > Organisations is the root-level entity for the Versori platform. All resources are scoped under an Organisation, each Organisation has an owner and can have multiple members. - name: signing-keys description: > Signing keys are used to sign JWTs which can be used to authenticate requests to the Versori platform. paths: /organisations/{organisation_id}: parameters: - $ref: '#/components/parameters/organisation_id' get: summary: Get Organisation description: Get an Organisation by its ID operationId: GetOrganisation responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Organisation' default: description: Error content: application/json: schema: $ref: '#/components/schemas/Error' components: parameters: organisation_id: name: organisation_id in: path x-go-name: OrganisationID required: true schema: type: string schemas: Organisation: type: object properties: id: type: string format: ulid x-go-name: ID x-go-type: ulid.ULID x-go-type-import: path: versori.dev/vergo/ulid slug: type: string displayName: type: string owner: type: string billing: $ref: '#/components/schemas/Billing' systemServiceAccountClientID: description: >- SystemServiceAccountClientID is the client ID of the system service account for this Organisation. This is automatically created when the Organisation is created and is used by internal services which must authenticate on behalf of the Organisation. It cannot be deleted. type: string plan: description: Subscription plan the organisation is enrolled. type: string required: - id - slug - displayName - owner - billing - systemServiceAccountClientID Error: type: object properties: code: type: string description: Code is a machine-readable error code. message: type: string description: Message is a human-readable error message. cause: type: string x-go-type-skip-optional-pointer: true required: - code - message Billing: description: >- Billing contains information about the billing status of an Organisation. type: object properties: platformId: description: >- PlatformID is an internal identifier to link the Billing profile to Versori's underlying billing platform. type: string platformType: type: string description: >- PlatformType denotes which billing platform is used for this billing profile. Currently only "stripe" is supported, and can be used to infer data type of other objects which are not documented as part of this API. See Subscription#raw for an example. customerId: description: >- CustomerID is the identifier for the customer in the billing platform. type: string subscriptionId: description: >- SubscriptionID is the identifier for the subscription in the billing platform. This is used to manage the subscription, i.e. update the subscription, cancel the subscription, etc. type: string billingEmail: description: >- BillingEmail is the email address used for billing purposes, i.e. sending invoices. This does not take up a seat in the Organisation plan. type: string recentSubscriptions: description: >- RecentSubscriptions is a list of subscriptions for the Organisation. This will only include the first 10 subscriptions, if there are more then the GetSubscriptions operation (to be implemented) should be used. type: array items: $ref: '#/components/schemas/Subscription' isSubscriptionActive: description: >- IsSubscriptionActive is true if the Organisation has an active subscription, otherwise false. An active subscription is a valid subscription on a free trial or one that has up-to-date payment methods. A value of 1 means the subscription is active. type: integer x-go-type: int8 hasMoreSubscriptions: description: >- HasMoreSubscriptions is true if there are more subscriptions than the ones returned in RecentSubscriptions. These may only be retrieved using the GetSubscriptions operation (to be implemented). type: boolean freeTrialEndDate: description: >- FreeTrialEndDate is the date at which the Organisation's free trial will end. This is only populated if the Organisation is currently on the free trial. This time should always be in UTC. type: string format: date billingPeriodStart: description: >- BillingPeriodStart is the start date of the current billing period. This is the date at which the current billing period started. This time should always be in UTC. type: string format: date billingPeriodEnd: description: >- BillingPeriodEnd is the end date of the current billing period. This is the date at which the current billing period ends. This time should always be in UTC. type: string format: date isBespoke: description: >- IsBespoke is true if the Organisation is on a bespoke plan, i.e. not using Stripe for billing. type: boolean boardQuota: description: >- BoardQuota is the maximum number of Switchboard boards (NOT including hub boards) the Organisation is allowed to have. This is determined by the quantity of boards that are on the Organisation's subscription. It is also used to determine the amount of free executions and users that an organisation is allowed. type: integer hubBoardQuota: description: >- HubBoardQuota is the maximum number of Hub boards the Organisation is allowed to have. This is determined by the quantity of hub boards that are on the Organisation's subscription. It is also used to determine the amount of free executions and users that an organisation is allowed. type: integer required: - platformId - customerId - billingEmail - isSubscriptionActive - billingPeriodEnd - billingPeriodStart Subscription: description: >- Subscription contains information of the actual subscription in Versori's internal billing platform. type: object properties: id: type: string status: description: Status is the current status of the subscription, i.e. "active". type: string enum: - active - unpaid - trialing - cancelled rawData: description: >- RawData is the underlying subscription object from the billing platform. This will typically be a Stripe [Subscription](https://stripe.com/docs/api/subscriptions/object) but is implied from the `Billing#platformType` property. ````