Skip to main content
GET
/
organisations
/
{organisation_id}
Get Organisation
curl --request GET \
  --url https://platform.versori.com/api/organisations/v1/organisations/{organisation_id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "slug": "<string>",
  "displayName": "<string>",
  "owner": "<string>",
  "billing": {
    "platformId": "<string>",
    "customerId": "<string>",
    "billingEmail": "<string>",
    "isSubscriptionActive": 123,
    "billingPeriodStart": "2023-12-25",
    "billingPeriodEnd": "2023-12-25",
    "platformType": "<string>",
    "subscriptionId": "<string>",
    "recentSubscriptions": [
      {
        "id": "<string>",
        "status": "active",
        "rawData": "<unknown>"
      }
    ],
    "hasMoreSubscriptions": true,
    "freeTrialEndDate": "2023-12-25",
    "isBespoke": true,
    "boardQuota": 123,
    "hubBoardQuota": 123
  },
  "systemServiceAccountClientID": "<string>",
  "plan": "<string>"
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
organisation_id
string
required

Response

OK

​
id
string<ulid>
required
​
slug
string
required
​
displayName
string
required
​
owner
string
required
​
billing
object
required

Billing contains information about the billing status of an Organisation.

​
systemServiceAccountClientID
string
required

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.

​
plan
string

Subscription plan the organisation is enrolled.