Products: Managed Backup (Agent)
Article ID: m0633Last Modified: 10-Oct-2025

GET API/Companies/{ID}

Retrieves a company by the specified company ID.

Request Information

URI Parameters

Name Description Type Additional Information
id Company ID string Required

Body Parameters

None.

Response Information

Resource Description

Returns a requested company details.

Name Description Type Additional Information
Id Company Id GUID None
Name Company Name string None
StorageLimit Company backup limit. A negative value indicates the resource is unconstrained by a quota
integer None
LicenseSettings Company license settings: 0 - Custom (Users have custom license settings) 1 - Global Pool (Users activate paid licenses from the global pool automatically) 2 - Company Pool (Users can activate only limited number of paid licenses from the company pool) LicensingMode None
DestinationId Specifies IDs of the backup destinations assigned for a specific company array None
DefaultLicenses Specifies default license types for new installations on endpoints in a specific company integer None
AllowedLicenses Specifies allowed license types for a specific company array None

For license type enums refer to the following article.

Response Formats

application/json, text/json

{
  "Id": "00000000-0000-0000-0000-000000000000",
  "Name": "string",
  "StorageLimit": 0,
  "LicenseSettings": 0,
  "Destinations": [
    {
      "DestinationId": "00000000-0000-0000-0000-000000000000",
      "PlanId": 0
    }
  ],
  "DefaultLicense": 0,
  "AllowedLicenses": [
    0
  ]
}

application/xml, text/xml

<CompanyModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MBSAPImvc.Engine.Models">
  <LicenseSettings>CustomUsersSettings</LicenseSettings>
  <Name>sample string 2</Name>
  <StorageLimit>1</StorageLimit>
  <Id>fb863472-9558-4c51-8e95-fde9f5a09b0a</Id>
</CompanyModel>
https://git.cloudberrylab.com/egor.m/doc-help-mbs.git
Production