Basic API usage

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


Welcome to User.com basic API overview. This tutorial will help you learn and understand the basics of using User.com API to get the data you need and develop integration with our application.

An API is an application programming interface - in short, it’s a computing interface to another software component. REST stands for Representational State Transfer. You can perform many different methods (POST, PUT, GET, DELETE) over HTTP.

Our docs are divided into sections responding to the Web application panel. From the dropdown menu on the left, you can choose an interesting section and then search for the desired endpoint. Every page starts with a short description/usage example. Then we move to the request parameters overview. After that, you can find snippet codes for programming languages like:

- jQuery, Javascript, Node.js, PHP and Python.

Also, we include a simple snippet for curl requests.

Every request begins with https://<your_app_subdomain>.user.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://<your_app_subdomain>.user.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://<your_app_subdomain>.user.com/api/public/users/:id/"

Response pagination

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

If I send a request to https://.user.com/api/public/users/?page=5, I'll get 50 results on 5th page and URLs to previous & next page (indexing started from 0).

{
  "next": "https://<your_app_subdomain>.user.com/api/public/users/?page=6",
  "previous": "https://<your_app_subdomain>.user.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.