The Multilogin API documentation helps you find requests for managing Android cloud phones, browser profiles, and other Multilogin resources. You can see what each request does, what information it needs, and what response to expect.

➡️ Open the Multilogin API documentation → choose a folder in the left sidebar → select a request → check its parameters and examples.

You can explore the documentation without installing anything. When you're ready to try a request, open the collection in Postman to send it without writing code, check the response, and save it for later use.

For regular automation, use an automation token. It lasts longer and allows more requests per minute than a regular API token.

Before you start

Install Postman 

You’ll need Postman with the Multilogin API collection imported:

1. Install Postman
2. Open the Multilogin API documentation and click “Run in Postman”
3. Click “Import”

Where can I find the API request I need?

The left sidebar groups API requests into folders based on what you want to do. Find the task you need, then open the matching request.

Here are some of the main folders:

• “Mobile Profile Management”: create, update, start, stop, and manage Android cloud phones
• “Launcher”: start and stop browser profiles, including quick profiles
• “Profile Management”: create, update, delete, and organize browser profiles
• “Profile Access Management”: manage API sign-in, tokens, and workspace information
• “Proxy”: manage proxies and check proxy-related information
• “Script Runner”: launch supported automation scripts
• “Object Storage”: upload and download files
• “2FA”: manage two-factor authentication through the API

For example, if you need a list of your Android cloud phones, open “Mobile Profile Management” → “Mobile Profile List”.

You don't need to remember endpoint URLs. Just find the action you want to perform.

What does each part of an API request mean?

An API request tells Multilogin what to do, such as getting your cloud phone list or updating a browser profile. The response tells you what happened.

When you open a request in the documentation, you'll find:

1. HTTP method: the method required for that request, such as GET, POST, PUT, or DELETE 
2. Endpoint: the URL where you send the request
3. Parameters: values such as profile IDs, filters, or page numbers – some are required, while others are optional
4. Headers: additional request information, such as an authorization token
5. Request body: data you send to the API, such as profile settings
6. Response: the result returned by Multilogin, including its status code and any response data

You'll also see JSON in many requests and responses. It's simply a text format that organizes information into fields and values.

Where can I find example requests and responses?

Examples show you what to send and what result to expect. You'll find them in both the online API documentation and the Postman app, but in different places.

In the online API documentation:

• “Example Request”: shows the code and information needed to send a request
• “Example Response”: shows what the API might return

In the Postman app:

• Request details: check “Params”, “Authorization”, “Headers”, and “Body” for the information you need
• Saved examples: expand a request in the sidebar to find examples like “Profiles Found”
• Actual response: click “Send” to see your results and status code below the request

Need code for your script? Use “Code” in Postman's right sidebar. See how to generate client code.

For help understanding errors and request limits, see the Multilogin API rate limits and response codes.

Can I change how the documentation looks?

Yes! The top bar lets you adjust the layout and code examples to make the documentation easier to work with.

Layout

Choose whichever layout you find easier to read:

• “Single Column”: shows request details and examples one below the other
• “Double Column”: shows request details and examples side by side

Double Column is especially useful when you want to compare request parameters with an example without scrolling back and forth.

Language

The language menu lets you choose the programming language or format used for generated request examples, such as cURL.

For example, if you're preparing a request for a script, you can switch to a supported format and use the generated code as a starting point.

This doesn't change the language of the documentation itself.

You can also adjust language-specific code-generation settings when those options are available.

FAQs

Can't find an API request?

Check the folders in the left sidebar and make sure you're looking in the right group.

For example, cloud phone requests are under “Mobile Profile Management”, while browser profile requests are under “Profile Management” or “Launcher”.

Some older requests may also have been renamed or replaced. Check their descriptions for version information.

Your imported collection looks different from the documentation?

Your Postman collection might be older than the published documentation.

Import the latest “Multilogin API” collection and compare it with your existing copy. If you've customized your collection, duplicate or export it before deleting or replacing anything.