This is an archive version of the document. To get the most up-to-date information, see the current version.Get All User Locations
You can get a collection resource representation of all locations assigned to a user 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 user locations, send the GET HTTP request to the URL of the /users/{userUid}/locations collection.
HTTP Request
GET https://<hostname>:1280/api/v3/users/{userUid}/locations |
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 |
|---|---|---|---|---|---|
userUid | Path | String (uuid) | Yes | — | User 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 OrganizationLocation schema.
Example 
The following request returns a representation of all locations assigned to a user with UID 1172a446-0f2e-498a-8640-6f1cddd76a56
Request: GET https://localhost:1280/api/v3/users/1172a446-0f2e-498a-8640-6f1cddd76a56/locations
Request Header: Authorization: Bearer <Access-Token>
Response Code: 200 OK
Response Body: { "meta": { "pagingInfo": { "total": 1, "count": 1, "offset": 0 } }, "data": [ { "instanceUid": "e7d4276f-4c96-477f-a74d-63f0b6f31ad0", "organizationUid": "8702aa4d-8a6a-4c7f-8252-e7ba8cbee739", "name": "Default location", "quotaGb": 10, "isDefault": true } ] } |