Skip to main content

8x8 Administration - Address Management API

Address management API providing endpoints to create, retrieve, list, and delete addresses.

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 in the Accept header for requests that return a payload (GET). The synchronous DELETE endpoint returns no content (204) and is not versioned.

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

Base URL

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

Endpoints

EndpointMethodPurposeAsync?
/addressesGETRetrieve paginated list of addresses with filteringNo
/addressesPOSTCreate a new addressNo
/addresses/{addressId}GETRetrieve a specific address's detailsNo
/addresses/{addressId}DELETERemove an addressNo

OpenAPI Specification

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