Introduction to iP.1 Survey API

iP.1’s API allows your websites and applications to create dynamic surveys and deliver them via SMS, email or static links.

Get started

To use iP.1's API you need to register in our Web App to configure your account.

After creating an account, log in to our user portal to access your credentials as explained under the Authentication heading below.

API Endpoint

The base URL for all of our endpoints is as follows. https://api.ip1sms.com/v2/

All requests must be made using HTTPS.

Authentication

All endpoints are protected by authentication with HTTP Bearertokens provided by us. Each account can have multiple API tokens with different restrictions on allowed IP addresses etc. These can be accessed, created and edited in User Portal

Pagination

All endpoints that return a collection of documents (surveys, questions, etc.) have pagination enabled. We use the database style of pagination with start, limit and order as its parameter name or offset, limit and order by as they are called in MariaDB. By default, start, limit and order set to 0, 50 and ASC respectively, but you can 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 will also get a Link header that contains pagination information.

Link: <https://api.ip1sms.com/v2/surveys?start=201&limit=100&order=ASC>; rel="next",
      <https://api.ip1sms.com/v2/surveys?start=4901&limit=100&order=ASC>; rel="last"

This example includes a line break for readability.

Possible rel values ​​are: