Looking to build an integration? Our API allows you to connect your platform with our services with minimal integration effort. Built by developers for developers.

The Private Box API provides an API for you to easily see a customers mail items, place orders and more.

Getting Started

Here’s a quick rundown of what you need to know about working with the Private Box API.

What do I need to start?

1. A Private Box production, test or staging account. If you don't have one of these already, please contact support@privatebox.co.nz to have one created for you.

Private Box account: You’ll need access to at least one Private Box account in order to authenticate yourself via the API.

API Rate Limits

There is a rate limit on /login end point of maximum 5 attempts per 10 minutes. Otherwise, all other endpoints have a max request of 2 per second.

My first request

Getting a list of items:

1. Create a request in your favourite API tool

2. Add X-Device-Id

3. Send /login request

4. Verify your device

5. Call /items

Full API spec found at https://app.swaggerhub.com/apis-docs/privat6248/PrivateBoxAPI.