Get All Companies Managed by Reseller
You can get a collection resource representation of companies managed by a reseller with the specified UID.
Required Privileges
To perform this task, a user must have one of the following roles assigned: Portal Administrator, Service Provider Global Administrator, Service Provider Administrator.
Request
To get a representation of companies managed by a reseller, send the GET HTTP request to the URL of the /organizations/resellers/{resellerUid}/companies collection.
HTTP Request
GET https://<hostname>:1280/api/v3/organizations/resellers/{resellerUid}/companies |
Request Headers
The request contains the following headers.
Header | Required/Optional | Value | Description |
Authorization | Required | Bearer <Access-Token> | Authenticates a client who sends the request to the server. Must contain the access token for the current logon session in the Bearer <Access-Token> format. |
Accept | Optional | application/json | Specifies a media type of representation that is required in the response message. If the requested type is not supported, the server will return the response in the application/json media type. |
Request parameters
A list of parameters that are applicable for this operation:
Name | In | Type | Required | Default | Description |
|---|---|---|---|---|---|
resellerUid | Path | String (uuid) | Yes | — | Reseller UID |
limit | Query | Integer (int32) | No | 100 | Specifies the first N resources that must be returned in the output |
offset | Query | Integer (int32) | No | 0 | Excludes the first N resources from the query output |
Response
The server returns the following response to the client.
Response Code
A successfully completed operation returns response code 200 OK.
Response Headers
The response to this request contains the following headers. The response may also include additional standard HTTP headers.
Header | Description |
Content-length | The length of the response body. |
Content-type | The media type and syntax of the request body message: application/json; charset=utf-8 |
Response Body
In the response body, Veeam Service Provider Console returns a collection resource representation based on the Company schema.
Example 
The following request returns a representation of all companies managed by a reseller with UID debcdb55-afbd-4772-bf99-5ea6a3249f43.
Request: GET https://localhost:1280/api/v3/organizations/resellers/debcdb55-afbd-4772-bf99-5ea6a3249f43/companies
Request Header: Authorization: Bearer <Access-Token>
Response Code: 200 OK
Response Body: { "meta": { "pagingInfo": { "total": 2, "count": 2, "offset": 0 } }, "data": [ { "instanceUid": "93edf541-7758-4e3a-9719-042171dcc544", "name": "Gamma", "status": "active", "resellerUid": "debcdb55-afbd-4772-bf99-5ea6a3249f43", "subscriptionPlanUid": "951b86bc-7b11-42da-bac8-c660e2629b9e", "permissions": [] }, { "instanceUid": "20c8486b-8c20-4b24-86a5-7cf24351c504", "name": "Delta", "status": "active", "resellerUid": "debcdb55-afbd-4772-bf99-5ea6a3249f43", "subscriptionPlanUid": "951b44bc-7b11-42da-bac8-c664c2629b9e", "permissions": [ "rest" ] } ] } |
