Attention: Application upload is only available on the Pro plan.
Our API makes Pulsus services and data available so that your development team can simplify processes and provide superior experiences for employees and customers.
Access here to access our documentation.
With the documentation mentioned above, you can make GET, POST, and PUT requests.
You can use the program you prefer, or even the link itself will allow execution.
Below you will see an example request:
GET v1/groups
Returns a list of device groups
API URL
https://api.pulsus.mobi/v1/groups
Authentication
The API requires that the environment's ApiToken be passed in the header of the HTTP request.
Note: To generate your environment's token, contact our support by sending an email to [email protected]
Parameters
Name | Description |
ApiToken string * | (header) must be provided in the HTTP request header |
since_id integer | (query) Pagination - Fetches results starting from an ID greater than the provided |
max_id integer | (query) Pagination - Fetches results with IDs less than the one provided in |
ID string | (query) List of identifiers (IDs). |
* required parameters
The method will return the last 500 results. To fetch previous results, you need to use the “max_id” parameter.
The result will be displayed according to the environment's IDs, for example:
If you limit from ID 1000 to 2000, and all these IDs are active in the database, the return will be from 1000 to 1499.
Example Value (schema):
Response:
code | description |
200 | OK |
401 | Unauthorized/Invalid api token |
404 | Not Found |
422 | Unprocessable Entity |
500 | Internal Server Error |
Schemas:
Pulsus API Usage Limits
To ensure platform stability, security, and availability, Pulsus applies limits to the number of requests made via the API, as detailed in the table below:
* Each API call counts as one request.
Limits are calculated per Pulsus environment, taking into account the total sum of requests made by all tokens and integrations associated with the environment/account.
What happens when the limit is reached?
When one of the usage limits is reached, the API will return the following error:
429 Too Many Requests
In this case, the integration must wait for the rate limit window to reset before attempting another request.
We recommend that integrations:
Avoid unnecessary or repetitive queries;
Use available pagination and filtering parameters;
Implement retries with progressive intervals (backoff).
Once the window resets, requests can be processed normally.
Need a higher limit?
If the volume required for your integration exceeds the limit available in your current plan, please contact Pulsus Support.