This is an archive version of the document. To get the most up-to-date information, see the current version.Get Organization
You can get a resource representation of an organization 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 representation of an organization, send the GET HTTP request to the URL of the /organizations/{organizationUid} resource.
HTTP Request
GET https://<hostname>:1280/api/v3/organizations/{organizationUid} |
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 |
|---|---|---|---|---|---|
organizationUid | Path | String (uuid) | Yes | — | Organization UID |
Response
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 Organization schema.
Example 
The following request returns a representation of an organization with UID debcdb55-afbd-4772-bf99-5ea6a3249f43.
Request: GET https://localhost:1280/api/v3/organizations/debcdb55-afbd-4772-bf99-5ea6a3249f43
Request Header: Authorization: Bearer <Access-Token>
Response Code: 200 OK
Response Body: { "data": { "instanceUid": "debcdb55-afbd-4772-bf99-5ea6a3249f43", "name": "Alpha", "type": "provider", "taxId": "167638504", "email": "a.smith@alpha.com", "phone": "+1 (985) 429-3346", "country": 1, "state": 19, "city": "Motley", "street": "633 Hopkins Street", "notes": "", "zipCode": "56466", "website": "alpha.com", "companyId": "" } } |