Introduction to the iP.1 e-mail API

The iP.1 e-mail API allows you to connect your websites and applications to e-mail clients worldwide.

Getting started

To use our APIs, you first need to register an account. You can do this by visiting our webshop. Register a free trial account.

Once you have created your account, log in to our user portal to access your credentials, which are described in more detail in the step below.

API Endpoint

The base URL for all our endpints in our RESTful API is the following: https://api.ip1sms.com/v2/

All requests must be made using HTTPS.

Authentication

All endpoints are protected by authentication using HTTP Bearer tokens provided by us. Any account may have several API tokens with different restrictions on allowed IP-addresses etc. These can be accessed, created and edited in our User Portal

Sign in to the user portal with your iP.1 User that was created when you registered your account. Watch the instruction video below in order to create your API key.

Pagination

All endpoints in /v2/ which return a collection of documents (batches, messages etc.) have pagination turned on. We use the database style of pagination with start, limit and order as it's parameter names. start, limit and order are set to 0, 50 and ASC respectively but you may change them to your liking by adding them as query parameters when making your HTTP request like this

?start=0&limit=200&order=DESC

Link Header

You'll also receive a Link header which includes pagination information.

Link: ; rel="next", ; rel="load"

This example includes a line break for readability.

Possible values for rel is the following