Get Company
You can get a resource representation of a company 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, Company Owner, Company Administrator.
Request
To get a representation of a company, send the GET HTTP request to the URL of the /organizations/companies/{companyUid} resource.
HTTP Request
GET https://<hostname>:1280/api/v3/organizations/companies/{companyUid} |
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 |
|---|---|---|---|---|---|
companyUid | Path | String (uuid) | Yes | — | Company UID |
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 resource representation based on the Company schema.
Example 
The following request returns a representation of a company with UID 7f650471-e8d4-44e0-afaf-762b27cb1b68.
Request: GET https://localhost:1280/api/v3/organizations/provider/companies/7f650471-e8d4-44e0-afaf-762b27cb1b68
Request Header: Authorization: Bearer <Access-Token>
Response Code: 200 OK
Response Body: { "data": { "instanceUid": "7f650471-e8d4-44e0-afaf-762b27cb1b68", "name": "Gamma", "status": "creating", "resellerUid": "fc3207ec-f630-42e5-969e-f032c3706fbb", "subscriptionPlanUid": "9bcdff04-4b99-4338-b784-b4ee9b0a8789", "permissions": [] } } |
