Skip to content
Last updated

Public API

Welcome to the Public API documentation.

Important Notice — ePay Unavailability

We understand that some customers are currently unable to access ePay to view and pay invoices. We apologize for the inconvenience and frustration this has caused.

As part of an ongoing transition to a new payment processing platform, ePay is currently unavailable. Our team is actively working to complete the transition and restore online payment capabilities as quickly as possible.

Please rest assured that your account remains in good standing during this outage. We are aware that customers do not currently have access to the payment portal, and we will provide additional instructions as soon as the new payment solution is available.

We appreciate your patience while we make this improvement.

News

  • 1970-01-01: The use of lastModified date equal to or greater than 1970-01-01 results in a full table scan and if used in production will result in prod access being revoked due to perfromance implications.
  • Streaming API: The Streaming API using RabbitMQ is being replaced with Webhooks. The RabbitMQ support will be terminated in Q3 2026.
  • page=: page= in pagination related queries has been deprecated for over 6 months. It will be completely removed in Q2 2026.
  • total: Total count in pagination queries has been documented to help with understanding edge cases. We witnessed multiple consumers incorrectly using total in pagination queries. total in pagination requests is deprecated in lieu of totalCount endpoints in each pagination based query.

For detailed explanations of any of these topics, please refer to the appropriate KB article.

Getting Started

Use the left navigation to browse:

  • API Download: Download the Public API and Streaming API OpenAPI specifications (YAML)
  • Streaming API: Connection endpoints for AMQP/STOMP subscriptions
  • API Endpoints: Organized by functional categories
  • Knowledge Base: Implementation guides and best practices
  • Release Notes: Latest updates and changes

Environments

This API is available in multiple environments:

  • Mock
  • Sandbox
  • Production

Select your environment from the server dropdown above.

Download & view spec