Get Site List
Retrieves the list of Webex sites that the authenticated user is set up to use.
When the admin tries to get the site list via userEmail, if siteUrl is not specified, the API searches the user ID from the admin's default site. If siteUrl is specified, the API searches the user ID from the specified site.
Query Parameters
Email address for the user. This parameter is only used if the user or application calling the API has the admin-level scopes. If set, the admin may specify the email of a user and the API will return the list of Webex sites for that user.
URL of the Webex site to query. If siteUrl is not specified, the query will use the default site for the admin's authorization token used to make the call.
Response Properties
Array of sites for the user. Users can have one site or multiple sites. This concept is specific to Webex Meetings. Any siteUrl in the site list can be assigned as user's default site with the Update Default Site API.
Access URL for the site. Note: This is a read-only attribute. The value can be assigned as user's default site with the Update Default Site API.
Flag identifying the site as the default site. Users can list meetings and recordings, and create meetings on the default site.
Response Codes
The list below describes the common success and error responses you should expect from the API.
| Code | Status | Description |
|---|---|---|
| 200 | OK | Successful request with body content. |
| 201 | Created | The request has succeeded and has led to the creation of a resource. |
| 202 | Accepted | The request has been accepted for processing. |
| 204 | No Content | Successful request without body content. |
| 400 | Bad Request | The request was invalid or cannot be otherwise served. An accompanying error message will explain further. |
| 401 | Unauthorized | Authentication credentials were missing or incorrect. |
| 403 | Forbidden | The request is understood, but it has been refused or access is not allowed. |
| 404 | Not Found | The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method. |
| 405 | Method Not Allowed | The request was made to a resource using an HTTP request method that is not supported. |
| 409 | Conflict | The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once. |
| 410 | Gone | The requested resource is no longer available. |
| 415 | Unsupported Media Type | The request was made to a resource without specifying a media type or used a media type that is not supported. |
| 423 | Locked | The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again. |
| 428 | Precondition Required | File(s) cannot be scanned for malware and need to be force downloaded. |
| 429 | Too Many Requests | Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made. |
| 500 | Internal Server Error | Something went wrong on the server. If the issue persists, feel free to contact the Webex Developer Support team. |
| 502 | Bad Gateway | The server received an invalid response from an upstream server while processing the request. Try again later. |
| 503 | Service Unavailable | Server is overloaded with requests. Try again later. |
| 504 | Gateway Timeout | An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it. |
Header
Query Parameters
- Email address for the user. This parameter is only used if the user or application calling the API has the [admin-level scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user and the API will return the list of Webex sites for that user.
- URL of the Webex site to query. If `siteUrl` is not specified, the query will use the default site for the admin's authorization token used to make the call.
{
"sites": [
{
"siteUrl": "site1-example.webex.com",
"default": false
},
{
"siteUrl": "site2-example.webex.com",
"default": false
},
{
"siteUrl": "site3-example.webex.com",
"default": false
},
{
"siteUrl": "site4-example.webex.com",
"default": true
}
]
}