With Inperium API, you can easily access our apps and create integrations with other products. Our API is meant to be simple and human-readable: you send requests to endpoints and get responses, just like with any other REST API.
This API reference describes public Inperium endpoints and methods as well as explains important concepts that will help you create awesome integrations with Inperium products.
How is Inperium API organized?
Inperium allows access to all Inperium products as well as common services running under the hood. Depending on your goal, look for endpoints in a corresponding section:
- Sell API - provides access to contacts, companies, deals, and many more.
- Talk API - provides access to calls, auto-receptionist settings, etc.
- Hub API - provides access to common settings, user and role management, subscription settings, etc.
- Message Center API - facilitates sending and receiving emails within Inperium Sell.
- Object Bucket Storage API - manages documents and files stored with Inperium.
- Talk Call Queue API - manages call queue functionality in Inperium Talk.
- Talk Number Porting API - facilitates transferring phone numbers to Inperium Talk.
New to the API world? Need more details about REST API?
With an API (application programming interface), you can request data or send it to the app without any visual user interface (what you see on your screen). It’s handy for computer-to-computer interaction. In most cases, APIs sort of copy what humans do while using the app.
In REST APIs, the data is sent in and out through specially exposed gateways, called endpoints. A company with a public API allows access to its resources through a dedicated server. Together, the server name followed by an endpoint look like a regular URL. For example, for Inperium it can be
While each service operates differently, in general you will leverage standard HTTP methods such as
GET to query data and
PATCH to submit data. Standard HTTP responses such as
200 OK or
401 Unauthorized will notify on the call results. Along with these requests, you’ll send or receive data. For example, after querying the list of companies, you’ll get a
JSON with company objects. But to create a new company, you have to send a
company object in a
POST body instead.