Basic API usage

Briefly described how to use our API, simple request & example response.


Every request begins with https://app.userengage.com/api/public/

Every request ends with following trailing slash. Like the example URL above.

The next part of the URI depends on the type of request. For example: https://app.userengage.com/api/public/users/


This request will display list of all our users.

Example request

curl -X GET -H "Authorization: Token <your_64_char_api_key>" "https://app.userengage.com/api/public/users/:id/"

Response pagination

We're showing up to 25 results per page to prevent overload of data and slowing down your app.

If I send a request to https://app.userengage.com/api/public/users/?page=5, I'll get 25 results on 5th page and URLs to previous & next page.

{
  "next": "https://app.userengage.com/api/public/users/?page=6",
  "previous": "https://app.userengage.com/api/public/users/?page=4",
}

Request limits

Each user can send up to 500 requests per minute. This is for security reasons, and to not overload the servers.