Postman isn't just a tool – it's your sidekick for exploring and mastering APIs. Whether you're getting started with Multilogin X or fine-tuning complex flows, our API documentation makes your life a lot easier.

Left sidebar: endpoint library

The left sidebar is where it all begins. All endpoints are grouped into folders, based on utilities, such as:

• Launcher: start and stop normal and quick browser profiles, get profile metadata and others tools, 
• Profile Access Management: manage who can access your profiles, folders, and API tokens
• Profile Management: create, search, remove, update, and many other functions 
• Browser Profile Data: tools to manage data on your browser profiles and ensure smooth flow
• Proxy: generate new proxies and manage existing browser profiles
• Pre-made Cookies: collect reliable cookies for creating a trustworthy browsing history
• Script Runner: runs automation scripts with minimum knowledge
• Profile Import/Export: allows exporting and importing profiles from the machine
• Object Storage: enables file uploads and downloads from internal storage

Endpoint contents

Every endpoint gives you a full breakdown of how to make your request work – no guessing needed. Here’s what you’ll find when you click one:

• Method type: GET, POST, PUT, or DELETE request – helps you know what action it performs
• Endpoint path: the specific URL path used to hit that endpoint
• Parameters:
  • Headers: information such as your authorization token 
  • Query params: optional add-ons to pass into the URL
  • Path variables: swappable parts of the URL
• Example request body: shows exactly what you need to include in your POST/PUT requests
• Example JSON bodies: a template to show what to expect from the results

Endpoints are like instruction cards: each one tells you exactly what info to send and what you’ll get back. Whether you're just copying the sample JSON or tweaking headers, this helps you avoid errors.

Example requests and responses

At the bottom or right side of most endpoints, you’ll see an Example Request and Example Response, which can be used to avoid having to construct any code from scratch.

• They serve as templates: copy and paste directly in Postman!
• Especially useful when building sequences or debugging errors
• You can change the coding language from the top bar
• Response bodies comes automatically in JSON

Top bar: visualization styles

The top bar enables you to tweak your preferred visualization style: 

Layout menu allows choosing how the contents of the page will be disposed:

• Single Column: both endpoint contents and example requests are shown vertically
• Double Column: endpoint contents located in the center; request and response examples located at the right

Language menu allows choosing you can select what is your preferred coding language.

• At the Engine icon at the right, you are able to edit specific criteria from your preferred language:
  • How the requests will be shown in your coding language:
    • Setting indentation count and type
    • Trim and “prettify” unnecessary details
  • How the requests should behave technically:
    • Choosing a request timeout limit
    • Activate HTTP follow redirects

Top bar: running in Postman

At the very right of the Top bar, you will find a Run in Postman icon. 

1. Click on "Run in Postman" → you will be able to export the endpoints directly
2. Download and install Postman
3. Click “Postman for <your OS>” (recommended)
4. In “Import collection” → choose the folder to import the Multilogin X API collection
5. Click “Import”

Set your local Postman environment

Already added the collection to your Postman? It should look like this, the same great documentation, but now directly saved in your local workspace!