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 references API

Find references to identifiers (extensions and service codes)

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

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

This API exposes 1 operation across 1 path, and defines 10 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.

1 operations 1 paths 10 schemas 1 GET

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 references API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearer_auth).

  • bearer_auth — JSON Web Token

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 GET. Each is listed below with its method, path, parameters, and response codes.

references 1

Find references to identifiers (extensions and service codes)

GET
/tenants/{tenant}/references
Find references to an identifier
findReferences 3 params → 404400401200503500

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are ReferenceItem (6 properties), Error (4 properties), Field (2 properties), IdentifierReferences (2 properties). Each schema is shown below with its type and property counts.

IdentifierReferences
object
IdentifierReferences groups references for a single identifier.
2 properties 2 required
ReferenceItem
object
ReferenceItem represents a single reference to an identifier within the tenant's configuration.
6 properties 2 required
Error
object
Error represents the standard API error response.
4 properties
ReferenceType
string
ReferenceType represents the type of entity that contains the reference.
HierarchicalReferences
object
HierarchicalReferencesResponse represents references grouped by identifier. This is returned when flatten=false.
1 property 1 required
FlatReferences
object
FlatReferencesResponse represents a flat array of references with identifier field on each item. This is returned when flatten=true (default).
1 property 1 required
Field
object
Field represents a field within an entity that references the identifier.
2 properties 1 required
References
FindReferencesResponse represents the response from the findReferences endpoint. The response structure depends on the 'flatten' parameter: - flatten=true: Fla…
ErrorDetail
object
ErrorDetail represents error details in the delete response.
2 properties
Data
object
Data represents key-value pair for additional reference metadata.
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nfon-references-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