Skip to main content

8x8 Administration - User Management API

User management API providing endpoints to create, retrieve, list, update, and delete users.

The current version of the API is v1.0.

Authentication​

All requests to this API require authentication using an API key. Include your API key in the request header:

x-api-key: YOUR_API_KEY

Versioning​

The API version is specified through a vendor-specific media type. Send it in the Content-Type header for requests that carry a payload (such as POST and PUT) and in the Accept header for requests that return a payload (GET, and asynchronous DELETE operations that return an operation resource).

Content-Type: application/vnd.users.v1+json   # on POST/PUT (request payload)
Accept: application/vnd.users.v1+json # on GET (response payload)

Base URL​

https://api.8x8.com/admin-provisioning

Endpoints​

EndpointMethodPurposeAsync?
/usersGETRetrieve paginated list of users with filteringNo
/usersPOSTCreate a new user accountYes
/users/{userId}GETRetrieve a specific user's detailsNo
/users/{userId}PUTUpdate an existing user accountYes
/users/{userId}DELETERemove a user accountYes

OpenAPI Specification​

Download the complete OpenAPI specification: user-api-v1.yaml