POST
/
v3
/
orgs
curl --request POST \
  --url https://api.ctrl-hub.com/v3/orgs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "data": {
    "type": "organisations",
    "attributes": {
      "name": "Ctrl Hub",
      "description": "Ctrl Hub deliver best in class software for managing your compliance, safety, risk and resource requirements"
    }
  }
}'
{
  "data": {
    "type": "organisations",
    "id": "7e0c875a-fd47-401d-bd25-4278ed58d721",
    "attributes": {
      "name": "Ctrl Hub",
      "slug": "ctrl-hub",
      "description": "Ctrl Hub deliver best in class software for managing your compliance, safety, risk and resource requirements",
      "settings": {
        "nomenclature": {
          "governance": {
            "schemes": [
              {
                "language": "en-GB",
                "singular": "Scheme",
                "plural": "Schemes"
              }
            ],
            "work_orders": [
              {
                "language": "en-GB",
                "singular": "Work Order",
                "plural": "Work Orders"
              }
            ],
            "operations": [
              {
                "language": "en-GB",
                "singular": "Operation",
                "plural": "Operations"
              }
            ]
          }
        }
      }
    },
    "meta": {
      "created_at": "2024-06-13T07:15:23.000Z",
      "status": "active"
    },
    "links": {
      "self": "https://api.ctrl-hub.com/v3/orgs/7e0c875a-fd47-401d-bd25-4278ed58d721"
    }
  }
}

Once an organisation has been created, the API will create a unique slug for you. This is derived from the organisation name, which is lowercased and all non alpha numeric characters are replaced with a dash (-).

Once an organisation has been created, the slug becomes immutable - even if the organisation name changes in the future..

The API will handle some of the attributes for the Organisation when it is created - attributes.slug, meta.created_at, meta.status and relationships.owners are all generated by the API.

You cannot change owners until at creation time and only an owner can add other owners. If you do want to add other owners, make sure you use credentials for the same actor that you used for the create request.

Authorizations

​
Authorization
string
header
required

To understand how to authenticate, see the auth docs

Body

application/json
​
data
object

Response

200
application/json
​
data
object