8X8x8
Sites

List sites

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

get/sites

Request

Query parameters

pageSizeinteger
Example:100

Number of items per page (default: 100)

pageNumberinteger

Page number (0-indexed, default: 0)

filterstring
Example:name==Office*

Filter expression using RSQL syntax. Only filtering by 'name' field is supported. Supports exact match and wildcard patterns.

Examples:

  • Exact match: name==Headquarters
  • Wildcard at end: name==Office*
  • Wildcard at start: name==*Office
  • Wildcard at both ends: name==Branch

Only the '==' operator is supported. Logical operations (AND/OR) are not supported.

sortstring
Example:name

Sort expression. Use '+' prefix or no prefix for ascending order, '-' prefix for descending order (e.g., 'name', '+name', or '-name')

Headers

X-Request-Idstring uuid

Optional request identifier for tracking

Response

Successful response with paginated sites

Example response

{
  "data": [
    {
      "id": "0023OEZiR7qQ_EGb6xYjgg",
      "name": "SanJose-Onel",
      "locale": "en-US",
      "timezone": "Europe/London",
      "address": {
        "id": "b1c4944a-17a0-4b00-8d48-36001df07e22"
      },
      "siteCode": "1345",
      "extensionLength": 4,
      "emergencyNotifications": [
        {
          "type": "EMAIL",
          "values": [
            "john.doe@corp.com",
            "jane.doe@corp.com"
          ]
        }
      ],
      "callerIdSettings": {
        "mainNumber": "+12266280120",
        "setMainNumberAsCallerId": true,
        "displayName": "John Doe"
      },
      "defaultDialPlanCallingCountry": "NANP",
      "defaultDialPlanRuleset": "INTERNATIONAL",
      "defaultVoicemailZeroOutDestinationExtensionId": "0ejGzqYBSIiMloUrreLXmA",
      "defaultVoicemailZeroOutDestinationExtensionNumber": "1032"
    }
  ],
  "pagination": {
    "pageSize": 100,
    "filter": "name==Headquarters",
    "sort": "name"
  },
  "_links": {
    "self": {
      "href": "https://api.8x8.com/admin-provisioning/sites?pageSize=100&pageNumber=0"
    },
    "next": {
      "href": "https://api.8x8.com/admin-provisioning/sites?pageSize=100&pageNumber=0"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.