The Public API is a tool that allows developers to interact with the Eskuad platform and access relevant data and information. This documentation aims to provide a detailed description of the available endpoints, accepted parameters, and expected responses, and serve as a guide for proper integration with the API.
Every endpoints of the Public API require authentication. In order to access platform information, developers must include an API key in their requests. The key can be obtained by any administrator on the platform by accessing the integrations tab in the configuration menu.
Once there, select the "Create new key" option. Then give a description for the key (e.g. "Key for integration with PowerBI"), along with the level of permissions that will be granted with the key: read-only or read/write.
Once created, the new access key will be in the key column.
To include the API key in the requests, the following header must be added:
api-key: <apikey>
To use the Public API, a request must be made to the following base URL:
<https://api.eskuad.com/api>
It is important to make sure to include the API key in all requests.
After the base URL, the version of the endpoint to be used must be indicated. Currently, all endpoints are in version 1, so the base URL will be as follows:
<https://api.eskuad.com/api/v1>
The Public API has the following endpoints.
GET /form-updates: Allows to obtain a list with the details of completed forms.The endpoints accept different parameters to filter and obtain specific information. The parameters are as follows: