Skip to main content

API Requests

Learn how to create, configure, and send HTTP requests using Fetch Client.

🚀 Create Your First Request

Creating a request only takes a few steps:

  1. Click New Request.
  2. Select an HTTP Method.
  3. Enter the request URL.
  4. Configure authentication (if required).
  5. Add headers, query parameters, or a request body.
  6. Click Send.

🌐 HTTP Methods

Fetch Client supports all standard HTTP methods.

MethodDescriptionCommon Use
GETRetrieve dataFetch users
POSTCreate resourcesCreate a user
PUTReplace resourcesUpdate a user
PATCHPartially update resourcesChange an email
DELETERemove resourcesDelete a user
HEADRetrieve headers onlyCheck resource availability
OPTIONSDiscover supported methodsAPI capabilities

🔗 URL & Query Parameters

Query parameters allow you to pass additional information in the URL.

https://api.example.com/users?page=1&limit=10

To add query parameters:

  1. Open the Query Params tab.
  2. Click Add Parameter.
  3. Enter the parameter name and value.
  4. The request URL updates automatically.

🔐 Authentication

Fetch Client supports multiple authentication methods.

AuthenticationBest For
Basic AuthUsername & Password
Bearer TokenJWT & Access Tokens
API KeyHeader or Query authentication
AWS SignatureAWS APIs
OAuth 2.0Enterprise authentication

Basic Auth

  • Username & Password authentication.
  • Credentials are automatically Base64 encoded.

Bearer Token

  • Uses access tokens (JWT).
  • Automatically adds the Authorization header.

API Key

Supports:

  • Header
  • Query Parameter

AWS Signature

Supports AWS Signature Version 4 authentication.

Configure:

  • Access Key
  • Secret Key
  • Region
  • Service

OAuth 2.0

Uses the OAuth 2.0 protocol to securely obtain and use access tokens.

Supported grant types:

  • Authorization Code
  • Authorization Code with PKCE
  • Client Credentials
  • Resource Owner Password Credentials (Password)

Features:

  • Automatic authorization flow for Authorization Code
  • PKCE support with configurable code challenge methods
  • Automatic access token retrieval and injection
  • Configurable client authentication (Header or Request Body)
  • Custom scopes
  • Audience and Resource parameters
  • Custom token field name
  • Variable support for OAuth configuration values

How to set up:

  1. Select OAuth 2.0 from the Auth tab.
  2. Choose the required Grant Type.
  3. Configure the required settings:
    • Access Token URL
    • Authorization URL (Authorization Code only)
    • Client ID
    • Client Secret
    • Scope (optional)
  4. Configure any advanced options such as:
    • Client Authentication
    • Audience
    • Resource
    • Token Name
  5. Click Get New Token.
  6. Fetch Client completes the authorization flow, retrieves the access token, and automatically includes it in the Authorization header for subsequent requests.

📝 Headers

Headers provide additional metadata for requests.

Examples include:

  • Authorization
  • Content-Type
  • Accept
  • User-Agent
  • Cache-Control

Features:

  • Header auto-completion
  • Header value suggestions
  • Enable/Disable headers
  • Automatic Content-Type detection

📦 Request Body

Choose the request body format that matches your API.

TypeDescription
Form DataUpload files and form fields
Form URL EncodedHTML form submissions
RawJSON, XML, Text
BinaryUpload a file
GraphQLGraphQL queries & variables

Form Data

Use multipart form data to upload files.

Form URL Encoded

Send standard HTML form data.

Raw

Supported content types:

  • JSON
  • XML
  • Plain Text
  • HTML

Binary

Upload a single file with automatic content-type detection.

Binary file upload with automatic Content-Type detection

GraphQL

Supports:

  • Queries
  • Mutations
  • Variables

Example query:

query GetUser($id: ID!) {
user(id: $id) {
name
email
}
}

Example variables:

{
"id": "12345"
}

🌍 Variables

Variables can be used throughout requests.

{{base_url}}/users

Authorization:
Bearer {{access_token}}

Supported variable scopes:

  • Global Variables
  • Collection Variables
  • Request Variables
  • Environment Variables
  • System Variables
tip
  • Use environments instead of hardcoded URLs.
  • Store secrets in variables.
  • Save frequently used requests into collections.
  • Reuse authentication with variables.
  • Add tests to validate responses automatically.

➡️ Next Steps