Clicky

REST API

Updated 4 months ago by Daniel

The REST API provides programmatic access to read and write data of Multilogin browser profiles. Create a new browser profile, get a list of all browser profiles, add a browser profile to a group and more.

REST API endpoints

There are two versions of Rest API – v1 and v2. Rest API v1 is used in Multilogin 2.x and 3.x. However, Creation of browser profiles on 3.x version can be only accomplished using Rest API v2.

Rest API v1 and v2 endpoints are available in our Swagger documentation (A.k.a OpenAPI Specification):

Rest API v1 in Swagger

Rest API v2 in Swagger

User authentication and API token

All requests are authenticated by the user’s access token (per-login basis), which is sent along with the desired endpoint. The token can be found in the app.properties file, which is usually located in the following directory:

C:/Users/%username%/.multiloginapp.com/

You need to be actively logged in the account, for which you want to get an access token for.

Important! This authentication token is equivalent to your account password. Keep it secret and do not share it with third parties.

Plan limits

REST API are only available for users with Scale subscriptions, with certain endpoints limited to the number of requests per second.

If an API is accessed from a subscription plan, which does not include REST API usage, the server will respond with the following error:

{"status":"ERROR","value":"unauthorized"}

Rate limits

Rate limits are applicable to all paid plan subscriptions. They differ by two endpoint types:

  • For requests returning a list (E.g. listAllGroups) - 1 requests/minute
  • Create and Update requests - 1 requests/minute
  • All other requests - 10 requests/minute.

Upon reaching the limit, the server will respond with the following error:

{"status":"ERROR","value":"rate limit exceeded."}

Increased API rate limits are available in our custom plans. For further information, please contact our support team.


Was this article helpful?