Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Nfon Tenants API

The Tenants API from Nfon — 9 operation(s) for tenants.

Nfon Tenants API is one of 52 APIs that Nfon publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Tenants. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 9 operations across 9 paths, and defines 21 schemas. It is described by OpenAPI 3.1.0, at version 2.0-early-access.

Requests are made against a single base URL, https://api.nfon.com/call-history.

9 operations 9 paths 21 schemas 1 DELETE2 GET1 PATCH2 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2.0-early-access
Base URL
https://api.nfon.net/configuration/v1
Authentication
HTTP Bearer
Contact
License
NFON proprietary
Terms of Service
Resource Areas
1

Authentication & Security 1

Nfon Tenants API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearer_auth).

  • bearer_auth — JSON Web Token

Paths & Operations 9

Across 9 paths, the API surfaces 9 operations — 1 DELETE, 2 GET, 1 PATCH, 2 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

Tenants 9
GET
/tenants/{participantExternalIdentifier}/audit
get_224 1 param → 200403404
GET
/tenants/{participantExternalIdentifier}/audit/type
get_225 1 param → 200403404
PATCH
/tenants/{tenant}
Update tenant
updateTenant 1 param body → 404400503204500
POST
/tenants/{tenant}/billing-extensions
Create billing extensions
createBillingExtensions 1 param body → 404422201503500400
PUT
/tenants/{tenant}/unlock
Unlock tenant
unlockTenant 1 param → 404400503204500
POST
/tenants
Create tenant
createTenant body → 500409503201400
PUT
/tenants/{tenant}/stop-trial-period
Stop tenant trial period
stopTenantTrialPeriod 1 param → 404400503204500
DELETE
/tenants/{tenant}/purge
Purge tenant
purgeTenant 1 param → 404400503204500
PUT
/tenants/{tenant}/lock
Lock tenant
lockTenant 1 param → 404400503204500

Schemas 21

The contract defines 21 schemas that model the data the API accepts and returns. The most detailed are CreateTenantRequest (15 properties), UpdateTenantRequest (7 properties), NfonApiCollectionResponsePage (6 properties), String (6 properties). Each schema is shown below with its type and property counts.

PrimaryContact
PrimaryContactParams represents primary contact with address. This is named PrimaryContact in the OpenAPI spec.
TenantOptions
object
OptionsRequestParams represents tenant options. This is named TenantOptions in the OpenAPI spec.
6 properties 1 required
Contact
object
Contact is the struct that holds the contact in a request.
5 properties 2 required
String
object
Link to the last page
6 properties
NfonApiResponse
object
Standard API response envelope for a single resource
3 properties
ErrorResponse
object
ErrorResponse represents the standard error response format.
3 properties
TenantOptionsUpdate
object
OptionsUpdateParams represents tenant options update. This is named TenantOptionsUpdate in the OpenAPI spec.
1 property
NfonApiCollectionResponse
object
Collection response envelope
UpdateTenantRequest
object
PartialUpdateRequest represents tenant partial update request. This is named UpdateTenantRequest in the OpenAPI spec.
7 properties
ErrorDetail
object
ErrorDetail represents error details in the delete response.
2 properties
Address
object
Address is the struct that holds the address in a request. nolint:recvcheck // mixed receivers for zerolog/validation compatibility
4 properties 4 required
Error
object
Error represents the standard API error response.
4 properties
UpdateContact
object
UpdateContact represents partial update for contact information.
3 properties
CreateTenantRequest
object
CreateCustomerParams wraps needed fields to create a customer. This is named CreateTenantRequest in the OpenAPI spec.
15 properties 6 required
NfonApiCollectionResponsePage
object
Paginated collection response envelope
6 properties
TenantCreated
object
CreateCustomerResponse represents the Create Customer response structure. This is named TenantCreated in the OpenAPI spec.
1 property
CollectionLinks
object
Pagination links for collection responses
4 properties
BillingExtensionsCreated
object
BillingExtensionsCreated represents the response after creating billing extensions.
1 property 1 required
CreateBillingExtensionsRequest
object
CreateBillingExtensionsRequest represents the request to create billing extensions.
1 property 1 required
Links
object
Related resource links
NfonApiCollectionResponseNonPage
object
Non-paginated collection response envelope
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nfon-tenants-api-openapi.yml Raw ↑

Other APIs Nfon publishes across the network.

NFON Service Portal API (legacy)
Nfon Accounts API
Nfon address API
Nfon authentication API
Nfon Blacklist Profiles API
Nfon clip-screened-prefixes API
Nfon Contract Types API
Nfon Customer Announcements API
Nfon Customer Conference API
Nfon Customer Contracts API
Nfon Customer Device Types API
Nfon Customer Devices API