Getting Started Guide: Infomaniak API

This guide presents the possibilities offered by the Infomaniak API. 

The Infomaniak API

The Infomaniak API allows you to leverage the full potential of the Infomaniak ecosystem in your applications and using the language of your choice. The Infomaniak API is a REST API. The protocol used is HTTP, requests and responses are encoded in JSON format. Authentication is done via OAuth 2 protocol.

Accessing and using the Infomaniak API is completely free.

With the API, you will be able to automate a wide range of actions and tasks on Infomaniak products and services without having to use the product interfaces. Some examples of use are: 

• store data
• send direct mail campaigns
• stream video or radio
• order or manage products
• and much more!

For example, for a Mail Service: manage mailboxes, manage aliases, manage automatic replies, manage folders, etc.

Using the Infomaniak API Protocol

Create your first requests with the Infomaniak API

Read the documentation in English only on the possibilities offered by the API.

Request Format

The Infomaniak API is a REST API. The protocol used is HTTP, requests and responses are encoded in JSON. Authentication is done via OAuth 2 protocol.

To launch a request, it is necessary to use the following syntax: /{version}/{command_path}. It is possible not to indicate the version, but in this case the latest version will be applied.

To see all available requests with the Infomaniak API, consult this page.

API Response Codes

When using the Infomaniak API, you may encounter various response codes. These codes precisely indicate the status of your request.

You can find the complete list from this page.

Limits & Restrictions

There is a limit of 60 requests per minute with the Infomaniak API. This limit cannot be increased.

The use of the API is restricted to the products listed in the official documentation. Regular additions of products and services are made to it.

If the product or service you are interested in is in the documentation, you will be able to use the following requests: GET; POST; PATCH; PUT; DELETE.

Learn More

• Generate and manage API tokens
• Infomaniak API: Usage Protocol
• Infomaniak API: Documentation
• Newsletter API

• Make your first request using Curl
• Make your first request using PostMan

Complete list of tutorials (click here)