BusinessUnits

Business units are used for advanced access policies where users have different permissions on different entities in the system depending on the business units they are part of and how these business units are related to the entities.

Get all business units

get

Authorizations

ApiKey

AuthorizationstringRequired

Responses

200

OK

application/json

get

/v1/businessunits

HTTPcURLJavaScriptPython

GET /v1/businessunits HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200

OK

[
  {
    "Uid": "c6a51fba-1691-4dc8-96db-448163d2bfe8",
    "Alias": "BU1",
    "Name": "Business Unit 1",
    "Created": "2025-11-04T22:40:48.4770405+01:00",
    "CreatedBy": "Admin",
    "LastModified": "2025-11-04T22:40:48.4770531+01:00",
    "LastModifiedBy": "Admin"
  },
  {
    "Uid": "5311da19-cf13-485d-8b1e-0e1f75e55e5b",
    "Alias": "BU2",
    "Name": "Business Unit 2",
    "Created": "2025-11-04T22:40:48.4770555+01:00",
    "CreatedBy": "Admin",
    "LastModified": "2025-11-04T22:40:48.4770559+01:00",
    "LastModifiedBy": "Admin"
  }
]

Create a business unit

post

Authorizations

ApiKey

AuthorizationstringRequired

Body

application/json

Model for creating a business unit

Uidstring · uuidOptional

Unique identifier of the business unit

Aliasstring | nullableOptional

Alias of the business unit

Namestring | nullableOptional

Name of the business unit

Responses

200

OK

No content

post

/v1/businessunits

HTTPcURLJavaScriptPython

POST /v1/businessunits HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 85

{
  "Uid": "2f04e662-77b9-423b-b718-644479941b94",
  "Alias": "BU1",
  "Name": "Business Unit 1"
}

200

OK

No content

Update a business unit

put

Authorizations

ApiKey

AuthorizationstringRequired

Body

application/json

Model for updating a business unit

Uidstring · uuidOptional

Unique identifier of the business unit

Aliasstring | nullableOptional

Alias of the business unit

Namestring | nullableOptional

Name of the business unit

Responses

200

OK

No content

put

/v1/businessunits

HTTPcURLJavaScriptPython

PUT /v1/businessunits HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 85

{
  "Uid": "bcc09cf1-50eb-4f1e-a5be-22b48825683a",
  "Alias": "BU1",
  "Name": "Business Unit 1"
}

200

OK

No content

Get a specific business unit

get

Authorizations

ApiKey

AuthorizationstringRequired

Path parameters

uidstring · uuidRequired

Responses

200

OK

application/json

404

Not Found

application/json

get

/v1/businessunits/{uid}

HTTPcURLJavaScriptPython

GET /v1/businessunits/{uid} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "Uid": "befa190b-e137-4783-9408-e7601f365b87",
  "Alias": "BU1",
  "Name": "Business Unit 1",
  "Created": "2025-11-04T22:40:48.4812131+01:00",
  "CreatedBy": "Admin",
  "LastModified": "2025-11-04T22:40:48.4812236+01:00",
  "LastModifiedBy": "Admin"
}

Delete a business unit

delete

Authorizations

ApiKey

AuthorizationstringRequired

Path parameters

uidstring · uuidRequired

Responses

200

OK

No content

delete

/v1/businessunits/{uid}

HTTPcURLJavaScriptPython

DELETE /v1/businessunits/{uid} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200

OK

No content