---
title: "List sites"
method: GET
path: "/sites"
tags: ["Sites"]
---

# List sites

`GET /sites`

## Request

- Base URL: `https://api.8x8.com/admin-provisioning`
- URL: `https://api.8x8.com/admin-provisioning/sites`
- Auth: API key in header `x-api-key`
- TypeScript: <https://skmtc.dev/8x8/apis/8x8-administration-site-management-api/docs/sites/get.ts> (a function with typed inputs; its response is checked against the schema)

List sites with optional filtering, sorting, and pagination.
Filter by site name using RSQL expressions with wildcards.

## Query parameters

- `pageSize` integer
- `pageNumber` integer
- `filter` string
- `sort` string

## Headers

- `X-Request-Id` string, uuid

## Response `200`

Successful response with paginated sites

- SitePage
  - `data` Site[], nullable
    - `id` string, nullable
    - `name` string, required
    - `pbxName` string, required
    - `locale` 'da-DK' | 'de-DE' | 'en-AU' | 'en-GB' | 'en-US' | 'es-ES' | 'fi-FI' | 'fr-BE' | 'fr-CA' | 'fr-CH' | 'fr-FR' | 'it-IT' | 'ja-JP' | 'nl-BE' | 'nl-NL' | 'no-NO' | 'pl-PL' | 'pt-BR' | 'pt-PT' | 'sv-SE' | 'zh-CN', required
    - `timezone` string, required
    - `address` SiteAddress, required
      - `id` string, nullable
    - `siteCode` string, nullable
    - `extensionLength` integer, nullable
    - `emergencyNotifications` EmergencyNotification[], nullable
      - `type` 'EMAIL', nullable
      - `values` string[], nullable
    - `callerIdSettings` CallerIdSettings
      - `mainNumber` string, nullable
      - `setMainNumberAsCallerId` boolean, nullable
      - `shareMainNumberAsCallerId` boolean, nullable
      - `displayName` string, nullable
    - `defaultDialPlanCallingCountry` string, nullable
    - `defaultDialPlanRuleset` 'INTERNATIONAL' | 'DOMESTIC' | 'EMERGENCYONLY', nullable
    - `defaultVoicemailZeroOutDestinationExtensionId` string, nullable
    - `defaultVoicemailZeroOutDestinationExtensionNumber` string, nullable
  - `pagination` Pagination
    - `pageSize` integer, nullable: Number of items per page
    - `pageNumber` integer, nullable: Current page number (0-indexed)
    - `hasMore` boolean, nullable: Indicates if there are more pages available
    - `filter` string, nullable: RSQL filter expression used in the request
    - `sort` string, nullable: Sort expression used in the request
    - `nextScrollId` string, nullable: Scroll ID for retrieving the next page
  - `_links` PaginationLinks
    - `self` Link
      - `href` string, nullable: URL for the link
    - `next` Link
      - `href` string, nullable: URL for the link

## Other responses

- `400`: Bad Request - Invalid filter or query parameters
- `403`: Forbidden - Access denied to this resource
- `408`: Request Timeout - Downstream service timeout
- `429`: Too Many Requests - Rate limit exceeded
- `500`: Internal Server Error - Unexpected error occurred
- `503`: Service Unavailable - Service unavailable due to connectivity or network issues

---

[API](https://skmtc.dev/8x8/apis/8x8-administration-site-management-api.md) - [All operations](https://skmtc.dev/8x8/apis/8x8-administration-site-management-api/llms.txt) - [OpenAPI document](https://skmtc.dev/8x8/apis/8x8-administration-site-management-api/revisions/8e00e01e46e0?raw)