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
Responses
200
OK
get
GET /v1/businessunits HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200

OK

[
  {
    "Uid": "123e4567-e89b-12d3-a456-426614174000",
    "Alias": "text",
    "Name": "text",
    "Created": "2025-06-27T08:46:56.026Z",
    "CreatedBy": "text",
    "LastModified": "2025-06-27T08:46:56.026Z",
    "LastModifiedBy": "text"
  }
]

Create a business unit

post
Authorizations
Body

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
post
POST /v1/businessunits HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 75

{
  "Uid": "123e4567-e89b-12d3-a456-426614174000",
  "Alias": "text",
  "Name": "text"
}
200

OK

No content

Update a business unit

put
Authorizations
Body

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
put
PUT /v1/businessunits HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 75

{
  "Uid": "123e4567-e89b-12d3-a456-426614174000",
  "Alias": "text",
  "Name": "text"
}
200

OK

No content

Get a specific business unit

get
Authorizations
Path parameters
uidstring · uuidRequired
Responses
200
OK
get
GET /v1/businessunits/{uid} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "Uid": "123e4567-e89b-12d3-a456-426614174000",
  "Alias": "text",
  "Name": "text",
  "Created": "2025-06-27T08:46:56.026Z",
  "CreatedBy": "text",
  "LastModified": "2025-06-27T08:46:56.026Z",
  "LastModifiedBy": "text"
}

Delete a business unit

delete
Authorizations
Path parameters
uidstring · uuidRequired
Responses
200
OK
delete
DELETE /v1/businessunits/{uid} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200

OK

No content
PreviousBrowseNextCatalogues