Pax8 Public APIs

Welcome to the Pax8 REST API. The API enables users to automate many manual tasks in the Pax8 Platform. This includes but is not limited to managing companies, placing orders, updating subscriptions, looking up product information, and reading invoices.

Calls to the API use standard HTTP requests. Each call returns JSON-formatted data along with standard HTTP response codes.

Getting started

Here are some guidelines in getting started with Pax8's APIs:
✅ 1 - Start by getting a Pax8 API access token

• See the Integration Request page to see how you can generate an API access token via the Pax8 app

✅ 2 - Then use our documentation site or your own API client to generate requests

• Try logging in to this documentation site with your Pax8 credentials and you can make calls directly from the API reference and see a history of API calls as well.
  OR
• Use your own client code, Postman (no coding required API test application) or cURL from the command line/terminal

Formatting requests

Starting with a simple GET request is the easiest way to confirm you have connectivity to the API, you can authenticate, and you're getting data back from the API. Try logging in to this documentation site with your Pax8 credentials and you can make calls directly from the API reference and see a history of API calls as well.

Example Headers for Requests

The following headers are what you will commonly use while making requests

• Content-Type : application/json
• Authorization : Bearer ${accessToken}

The ${accessToken} value is a JWT that is obtained from the createAccessToken request.

Dynamic Data

Dynamic data is information that changes periodically over time as new information becomes available.
Endpoints such as Product Dependencies, Provisioning Details, and Pricing return dynamic data.
It is recommended to not store the responses from these endpoints, and to read the data prior to using it.

API Rate Limits

Pax8 uses rate limiting to control API traffic. All API requests are subject to rate limiting. The current rate limit is 1000 successful calls per minute. If you exceed the API rate limit you will receive an HTTP 429 error and will continue to be limited until the wait time has expired. Please email [email protected] to request a rate limit increase.

API Status Page

You can monitor the status of the API and subscribe for updates at status.pax8.com. The component will be shown as "Partner API".

Support For Partners

Please submit a support ticket for post walk-through assistance or directly contact your Pax8 Account Manager.

Support for Vendors

Please email [email protected] for Vendor Marketplace API questions.

Leverage AI to Build Your Integration

Consider leveraging Generative AI tools like GitHub Copilot, ChatGPT, or other AI models to assist with building your integrations. By providing these tools with our OpenAPI specification, available here, and details about your own systems, you can receive AI-generated mockups of your integration flow.

This allows for faster prototyping and reduced manual coding efforts. These tools can suggest optimized API request structures, error handling, and even code snippets that match your systems' architecture, greatly accelerating your integration process. More details are available here.