Skip to main content

Collections

Collections help you organize, save, and share related API requests.

Overview

Creating a Collection

  1. Go to the Collections tab in the sidebar
  2. Click New Collection
  3. Enter a name for your collection
  4. Click Create

Saving Requests

Save Current Request

  1. Configure your request (URL, method, headers, body)
  2. Click the Save button
  3. Select a collection from the dropdown
  4. The request is added to the collection

Request Naming

Requests are automatically named based on:

  • The request name field (if set)
  • The URL path (e.g., "GET /users")

Using Saved Requests

Loading a Request

  1. Expand a collection in the sidebar
  2. Click on a request
  3. A new tab opens with the request loaded

Editing a Request

  1. Load the request
  2. Make your changes
  3. Click Save and select the same collection

Collection Actions

Right-click on a collection to access:

ActionDescription
Run TestsOpen test runner with collection
Start Mock ServerGenerate mock server from collection
DeleteRemove collection and all requests

Organization

Naming Conventions

Use descriptive names:

  • User Management API
  • Authentication Endpoints
  • Payment Processing

Keep related endpoints together:

📁 E-commerce API
├── GET /products
├── POST /products
├── GET /products/:id
├── GET /orders
├── POST /orders
└── GET /orders/:id

Import & Export

See Import & Export for:

  • Importing from Postman
  • Importing from OpenAPI/Swagger
  • Exporting collections

Request Details

Each saved request stores:

FieldDescription
NameRequest identifier
ProtocolHTTP, WebSocket, etc.
MethodGET, POST, etc.
URLEndpoint URL
HeadersRequest headers
ParametersQuery parameters
BodyRequest body

Best Practices

Logical Grouping

Group requests by resource or feature:

  • All user endpoints in "Users" collection
  • All auth endpoints in "Authentication" collection
Variables in Collections

Use variables in saved requests for portability:

{{API_URL}}/users/{{USER_ID}}
Version Control

Keep collections organized by API version:

  • API v1 - Users
  • API v2 - Users

Collection Workflow

Development Flow

  1. Create Collection: Organize by feature/resource
  2. Add Requests: Save working requests
  3. Test Locally: Verify against real endpoints
  4. Run Tests: Automate with test runner
  5. Generate Mocks: Create mock server for development

Team Collaboration

Share collections by:

  1. Exporting the collection
  2. Sharing the JSON file
  3. Team members import into their Istek