Create Organisation

CreateOrganisation creates a new Organisation with the current user as the owner. A user can create as many Organisations as they like, but each has their own billing profile and must be on a paid plan to use certain features.

POST /organisations

Create Organisation

cURL

curl --request POST \
  --url https://platform.versori.com/api/organisations/v1/organisations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "slug": "<string>",
  "displayName": "<string>"
}
'

201

{
  "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>",
        "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.

Body

application/json

slug · string · required

Slug is a unique, lower-cased, human-readable identifier for this Organisation. It may only contain alphanumeric characters and hyphens, and must start with a letter.

displayName · string · required

Response

201

application/json

Created

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.

Show child attributes

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.