API Overview - Postmen

All entities are defined in the JSON schema format. Download the schemas to be able to validate your code.

Before you can start using our REST API services, you'll need to obtain an API key.

How to get your API Key?

1. Login to your Postmen account (Sign up free)
2. Go to https://secure.postmen.com/sandbox/api-keys to view and manage your api-keys.

Once you've registered your API key it's easy to start requesting data from Postmen. All endpoints are only accessible via https.

• Sandbox: https://sandbox-api.postmen.com/v3
• Production: https://production-api.postmen.com/v3

Request header

All API calls must include the postmen-api-key header in order to authenticate the usage of Postmen API. Replace YOUR_API_KEY with your own key. Content-Type for all calls should be application/json. The charset parameter provided in Content-Type header is by default set to UTF-8, it DOES NOT support any other encodings such like ISO-8859-1

postmen-api-key: YOUR_API_KEY
Content-Type: application/json

Request body

All requests and responses are in JSON.

The Envelope

To make each response as predictable as possible, each response is contained in an envelope with two keys: meta and data.

{
  "meta": {
    "code": 200
  },
  "data": {
    ...
  }
}

The meta key is used to communicate extra information about the response. If all goes well, you'll only ever see a code key with value 200. If something goes wrong for some reason, you'll get a response like:

{
  "meta": {
    "code": 401,
    "message": "Invalid API key.",
	"details": [],
    "retryable": false
  },
  "data": {}
}

The data key is the meat of the response and is where you'll find the requested data.

Here is the example for a GET /labels

{
  "meta": {
    "code": 200
  },
  "data": {
    "labels": [
      {
        ...
        ...
        ...
      }
    ]
  }
}