Skip to main content
GuidesAPI Reference

Administration API Reference

BETA - Limited Access

These Administration APIs are currently in Beta testing. API keys cannot be generated in Admin Console at this point. Only Beta program participants may use these APIs.

Welcome to the Administration API reference documentation.

Available APIs​

User Management API​

The User Management API allows you to manage users within your organization. You can:

  • Retrieve paginated lists of users with filtering and sorting
  • Create new users asynchronously
  • Get detailed information for specific users
  • Update existing users
  • Delete users

See the User Management API Reference documentation for more details.

Ring Group Management API​

The Ring Group Management API enables you to programmatically manage ring groups across your 8x8 voice infrastructure. You can:

  • Search and filter ring groups with advanced query capabilities
  • Create ring groups with custom routing patterns
  • Retrieve detailed ring group configurations
  • Update ring group settings and member assignments
  • Delete ring groups

See the Ring Group Management API Reference documentation for more details.

Site Management API​

The Site Management API allows you to manage sites (branches) within your organization. You can:

  • Search and filter sites across your organization
  • Create new sites with location and configuration details
  • Retrieve detailed site information
  • Update site settings and configurations
  • Delete sites

See the Site Management API Reference documentation for more details.

Phone Number Management API​

The Phone Number Management API provides read-only access to phone numbers in your organization. You can:

  • Retrieve paginated lists of phone numbers with filtering
  • Get detailed information for specific phone numbers

See the Phone Number Management API Reference documentation for more details.

Address Management API​

The Address Management API enables you to manage addresses associated with sites. You can:

  • Search and filter addresses with query capabilities
  • Create new addresses for site locations
  • Retrieve detailed address information
  • Delete addresses

See the Address Management API Reference documentation for more details.