Skip to main content
POST
/
v3
/
orgs
Create an organisation
curl --request POST \
  --url https://api.ctrl-hub.com/v3/orgs \
  --header 'Content-Type: application/vnd.api+json' \
  --header 'X-Session-Token: <api-key>' \
  --data '
{
  "data": {
    "type": "<string>",
    "attributes": {
      "name": "<string>",
      "description": "<string>",
      "sandbox": true
    }
  }
}
'
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "type": "<string>",
    "attributes": {
      "name": "<string>",
      "slug": "<string>",
      "sandbox": true,
      "settings": {
        "nomenclature": {
          "governance": {
            "schemes": [
              {
                "singular": "<string>",
                "plural": "<string>",
                "language": "<string>"
              }
            ],
            "work_orders": [
              {
                "singular": "<string>",
                "plural": "<string>",
                "language": "<string>"
              }
            ],
            "operations": [
              {
                "singular": "<string>",
                "plural": "<string>",
                "language": "<string>"
              }
            ]
          }
        }
      },
      "description": "<string>"
    },
    "meta": {
      "v3": true,
      "status": "active",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "features": [
        {
          "name": "<string>",
          "enabled": true,
          "limit": 123
        }
      ]
    },
    "relationships": {
      "users": {
        "data": [
          {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "type": "<string>"
          }
        ]
      },
      "service_accounts": {
        "data": [
          {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "type": "<string>"
          }
        ]
      },
      "groups": {
        "data": [
          {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "type": "<string>"
          }
        ]
      },
      "teams": {
        "data": [
          {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "type": "<string>"
          }
        ]
      }
    }
  },
  "jsonapi": {
    "version": "<string>"
  }
}

Authorizations

X-Session-Token
string
header
required

Session token for authentication.

Body

application/vnd.api+json

The organisation to create.

data
object
required

Response

Get an organisation.

JSON API response object

data
object
required

An organisation

jsonapi
object
required