How can we help?

Docs for
What's new
Admin manuals
Handbooks
UI help
Developers documentation
Looking for the old documentation portal? Click here
API documentation
  • API reference
    PortaOne has the following APIs in the OpenAPI format:

    PortaBilling API: Designed for admin, reseller, customer, account, distributor, and representative users to manage role-specific data and functions (e.g., a customer self-care portal will use API methods with customer credentials).

    The default format for date-time parameters in the PortaBilling API is “YYYY-MM-DD HH24:MI:SS” in the UTC time zone.

    External System Provisioning Framework (ESPF) API: Allows the automation of data synchronization between PortaBilling and external systems. When customer parameters change, provisioning events are recorded, and ESPF delivers these events to external systems. The ESPF API allows you to add events to the provisioning queue, schedule their processing time, and send provisioning status updates.

    PortaSIP API: Enables configuration of features such as auto-attendant, conferencing, and voicemail.

    Call Control API: Enables the management and monitoring of calls in real-time.

    Explore available API methods with their parameters, view request and response examples, and test requests directly within the API reference, where each API has a corresponding tab.

    If you are logged in to the PortaBilling web interface, navigate to Toolbox > API documentation for testing. Your credentials will be used automatically and you can start testing immediately.

    PortaBilling API 2.0

    PortaBilling API 2.0 uses a modern HTTP REST schema with clear, consistent attribute names that both developers and AI agents can easily understand. Unlike the previous API version, which mirrored database structures and required multiple calls to fetch related data, API 2.0 lets you include related objects in a single request and retrieve only the attributes you need. This reduces backend load and speeds up self-care portals and mobile apps. API 2.0 also improves error handling and messages, making troubleshooting easier. It works alongside the previous API to ensure a smooth transition.

  • External System Interfaces Guide
  • Provisioning Application Reference Guide
    Learn how to use PortaBilling provisioning events to notify external systems of customer parameter changes and to retrieve data from PortaBilling via the API.
Docs for
What's new
Admin manuals
Handbooks
UI help
Developers documentation