Getting Started

The PackageX Mailroom API is organized around REST. Our API has predictable resource-oriented URLs, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

Base URL https://api.packagex.app/v4/

Generating API Keys

The PackageX Mailroom API uses API keys to authenticate requests. You can view and manage your API keys in the PackageX Mailroom Dashboard.

To generate an API key, go the the settings on your dashboard and generate an API key. Your account role will need to either be admin to generate API Keys. The generated key will only be shown to you one time. If you lose track of the API key, there is no way to get it back, you will need to generate a new key.

Your API keys carry many privileges, so be sure to keep them secure! Do not share your API keys in publicly accessible areas such as GitHub, client-side code, and so forth.

All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.

Headers

To use your API key, send a header with your request with the prefix x-api-key followed by your key. Value: Available in the API section of the Web Dashboard (https://portal.packagex.app). For example, a javascript request would look like this:

fetch("<https://api.packagex.app/v4/>", {
  method: "POST",
  headers: {
    "x-api-key": process.env.X_API_KEY,
    "Content-Type": "application/json",
  },
});

PackageX Portal

Members API

Add New Member

POST /entity/exposed/member

This endpoint adds a new member to the specified building.