Skip to main content
In Requestly, you can send requests, inspect responses, organize APIs, and automate API testing workflows.

​
When To Use Requestly

Use Requestly when you want to:
  • Send REST or GraphQL requests manually
  • Manage collections, folders, and reusable environments
  • Add authorization, scripts, and assertions
  • Run repeatable request flows and share them with your team
If your goal is to inspect live traffic from an app or browser, start with HTTP Interceptor instead. If you need to rewrite traffic in-place, use HTTP Rules.

​
What You Can Do Here

Send Requests

Test REST and GraphQL APIs with full request and response controls.

Organize with Collections

Group related APIs into collections, folders, and reusable workflows.

Environment Variables

Switch between environments and reuse dynamic values safely.

Automate with Scripts

Add scripts, assertions, and automation logic in JavaScript.

​
Sending requests

Whether you are building your own API or working with a third-party service, Requestly lets you send GET, POST, PUT, PATCH, and DELETE requests. You can add query parameters, headers, request bodies, and authorization details to test how your API behaves across different scenarios. When you send a request, Requestly displays the API server’s response in a clear format so you can inspect, visualize, and troubleshoot it easily. Send API Request Screenshot

​
Quick Start

Welcome to Requestly! This walkthrough will get you sending requests, organizing them into collections, and using variables across environments in just a few minutes.

​
Prerequisites

  • The Requestly Desktop App — download if you don’t already have it installed.
  • An API endpoint to test, such as https://app.requestly.io/echo.
  • Optional: credentials or tokens if your API requires authorization.

​
Step 1: Send Your First API Request

Let’s start by sending a simple GET request.
1

Open API Client and Create a New Request

Click the API Client link in the left sidebar of the Requestly application, then click the + New button to create a new request and select Request from the menu.
2

Configure Your Request

  • Name: Send API Request
  • Method: GET
  • URL: https://app.requestly.io/echo
3

Send the Request

Click Save and then Send. You should see a JSON response with data in the response panel below.
🎉 Congratulations! You’ve sent your first API request with Requestly.

​
Step 2: Understand the Interface

The API Client interface is divided into key sections:

​
Step 3: Create Your First Collection

Collections help you organize related API requests.
1

Create a Collection

Click + New → Collection. Name it User Management APIs and press Enter.
2

Add Requests to Collection

Drag your previously created request into the collection, or create a new request directly inside the collection by clicking the + icon next to the collection name.
3

Organize with Folders

For larger projects, create sub-folders within collections:
  • Click the folder icon next to your collection name
  • Name it (e.g., Auth APIs, User APIs)
Collections can have their own variables and authorization settings that apply to all requests inside them. Learn more about collections →

​
Step 4: Set Up Environment Variables

Variables allow you to switch between different API environments (dev, staging, production) without changing your requests.
1

Create an Environment

Click + New → Environment. Name it Development and press Enter.
2

Add Variables

Add these variables to your environment:
Key: base_url
Value: https://jsonplaceholder.typicode.com

Key: api_token
Value: your_dev_token_here
Click Save.
3

Use Variables in Requests

Update your request URL to use the variable:
{{base_url}}/users/1
Variables are referenced using double curly braces: {{variable_name}}
4

Switch Environments

Use the environment dropdown in the top-right corner to switch between different environments.

Master Variables

Learn about different variable types: Global, Environment, Collection, and Runtime variables

​
Step 5: Try Advanced Features

Now that you know the basics, explore these powerful features.

​
Add Authorization

Protect your APIs with built-in auth support:
1

Open Authorization Tab

Click the Authorization tab in your request.
2

Select Auth Type

Choose from:
  • API Key
  • Bearer Token
  • Basic Auth
3

Enter Credentials

Fill in your authentication details (can use variables for security).
Full Authorization Guide →

​
Write Scripts

Automate your workflow with JavaScript: 
// Pre-request Script: Add timestamp
rq.environment.set("timestamp", new Date().getTime());

// Post-response Script: Save token
const response = rq.response.json();
rq.environment.set("auth_token", response.token);
Learn about Scripts →

​
Add Tests

Validate API responses automatically: 
// Test if response is 200 OK
rq.test("Status is 200", () => {
  rq.response.to.have.status(200);
});

// Test if response contains expected data
rq.test("User exists", () => {
  rq.response.to.have.jsonBody("user.name", "John");
});
Testing Documentation →

​
Import Existing APIs

Already using another API client? Import your work instantly:

From cURL

Paste cURL commands

From Postman

Import Postman collections

OpenAPI/Swagger

Import API specifications
In addition to standard HTTP requests, Requestly also supports other formats and protocols such as GraphQL and SOAP.

​
Explore Next

Create requests

Learn request configuration, headers, body handling, authorization, and history.

Environments & variables

Switch between dev, staging, and production without rewriting requests.

Assertions & automation

Add scripts, tests, and collection runs for repeatable API validation.

Import & export

Bring work in from cURL, Postman, or OpenAPI and share collections back out.

Collection runner

Execute multi-request workflows against environments and test data.

​
Need Help?

Having issues? Check out our troubleshooting guides or reach out to our support team.