How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Wazo Phonebook API

The phonebook API from Wazo — 11 operation(s) for phonebook.

Wazo Phonebook API is one of 113 APIs that Wazo publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include phonebook. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, a changelog, authentication docs, and an AsyncAPI specification.

This API exposes 23 operations across 11 paths, and defines 11 schemas. It is described by OpenAPI 3.2.0, at version 0.1.

Requests are made against a single base URL, /0.1.

23 operations 11 paths 11 schemas 4 DELETE9 GET6 POST4 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
0.1
Base URL
https://{wazo_stack}/api/auth/0.1
Authentication
API Key
License
Resource Areas
1

Authentication & Security 1

Wazo Phonebook API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-Auth-Token (wazo_auth_token). By default, every request must be authenticated.

Paths & Operations 23

Across 11 paths, the API surfaces 23 operations — 4 DELETE, 9 GET, 6 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.

phonebook 23
GET
/phonebooks
List all phonebooks for a given tenant
7 params → 200400503
POST
/phonebooks
Create a new phonebook
create_phonebook 1 param body → 201400404409503
GET
/phonebooks/{phonebook_uuid}
Get the attributes of a phonebook
2 params → 200400404503
PUT
/phonebooks/{phonebook_uuid}
Modify an existing phonebook
2 params body → 204400404409503
DELETE
/phonebooks/{phonebook_uuid}
Delete an existing phonebook
2 params → 204400404503
GET
/phonebooks/{phonebook_uuid}/contacts
List all contacts for a given phonebook
7 params → 200400503
POST
/phonebooks/{phonebook_uuid}/contacts
Create a new contact
create_phonebook_contact 2 params body → 201400409503
POST
/phonebooks/{phonebook_uuid}/contacts/import
Import multiple contacts at once
import_phonebook 2 params body → 201400503
GET
/phonebooks/{phonebook_uuid}/contacts/{contact_id}
Get the attributes of a contact
3 params → 200400404503
PUT
/phonebooks/{phonebook_uuid}/contacts/{contact_id}
Modify an existing contact
3 params body → 204400404409503
DELETE
/phonebooks/{phonebook_uuid}/contacts/{contact_id}
Delete an existing contact
3 params → 204400404503
GET
/backends/phonebook/sources/{source_uuid}/contacts
Get contacts from a phonebook source
list_phonebook_source_contacts 7 params → 200401404503
GET
/tenants/{tenant}/phonebooksdeprecated
List all phonebooks for a given tenant
6 params → 200400503
POST
/tenants/{tenant}/phonebooksdeprecated
Create a new phonebook
create_phonebook_deprecated 1 param body → 201400404409503
GET
/tenants/{tenant}/phonebooks/{phonebook_id}deprecated
Get the attributes of a phonebook
2 params → 200400404503
PUT
/tenants/{tenant}/phonebooks/{phonebook_id}deprecated
Modify an existing phonebook
2 params body → 204400404409503
DELETE
/tenants/{tenant}/phonebooks/{phonebook_id}deprecated
Delete an existing phonebook
2 params → 204400404503
GET
/tenants/{tenant}/phonebooks/{phonebook_id}/contactsdeprecated
List all contacts for a given phonebook
7 params → 200400503
POST
/tenants/{tenant}/phonebooks/{phonebook_id}/contactsdeprecated
Create a new contact
create_phonebook_contact_deprecated 2 params body → 201400409503
POST
/tenants/{tenant}/phonebooks/{phonebook_id}/contacts/importdeprecated
Import multiple contacts at once
import_phonebook_deprecated 2 params body → 201400503
GET
/tenants/{tenant}/phonebooks/{phonebook_id}/contacts/{contact_id}deprecated
Get the attributes of a contact
3 params → 200400404503
PUT
/tenants/{tenant}/phonebooks/{phonebook_id}/contacts/{contact_id}deprecated
Modify an existing contact
3 params body → 204400404409503
DELETE
/tenants/{tenant}/phonebooks/{phonebook_id}/contacts/{contact_id}deprecated
Delete an existing contact
3 params → 204400404503

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are Error (5 properties), Phonebook (4 properties), LegacyError (3 properties), PhonebookContact (3 properties). Each schema is shown below with its type and property counts.

LegacyError
object
Error message for the client
3 properties
PhonebookContact
object
3 properties
PhonebookContactImportError
Error(s) during contact import
PhonebookContactList
array
ContactImportResponse
object
2 properties
ContactImportFailure
object
2 properties
PhonebookBody
object
2 properties 1 required
PhonebookContactImportResponse
object
1 property
Phonebook
object
4 properties
Error
object
Error message for the client
5 properties
ContactBodySample
object
Those are only example attributes. The API accepts any arbitrary attributes.
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

wazo-phonebook-api-openapi.yml Raw ↑

Other APIs Wazo publishes across the network.

Wazo Phone Provisioning API (wazo-provd)
Wazo Websocket Event Stream (wazo-websocketd)
Wazo Aastra API
Wazo Access Features API
Wazo Action API
Wazo Adhoc Conferences API
Wazo Admin API
Wazo Agent Statistics API
Wazo Agents API
Wazo Applications API
Wazo Asterisk API
Wazo Backends API
Where this information came from

This is an independent, third-party profile of Wazo Phonebook API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.