Organize requests in folders and projects

The four levels, where shared content appears, and how to bring requests in.

In short

API Tester keeps your work in four levels: your workspace, folders, projects and saved requests. A project is a set of related requests that share environments and sign-in. Requests come in by hand, from OpenAPI, Postman, cURL, a HAR file or a browser recording.

Before you start

• Who: making a project or folder needs the right to add to the workspace (in an organization, "Use API Tester"). Moving or deleting a project, and filing it under a team, need Manage on it. Restoring a deleted request needs Edit.
• Plan: the number of projects you may hold depends on the plan (see Plan & usage).
• First: choose the workspace in the header; a project belongs to one workspace.

Steps

1. Press "New folder" to create a folder for an organization, product or environment.
2. Create a project inside it, with a short description and an optional source link to the task or specification.
3. Create or save requests in the project, and group them on the board by feature (Login, Users, Payments).

Result: the tree on the left shows your folders and projects, and each project's board lists its requests with their last results.

Bring requests in

Requests imported from OpenAPI call {{baseUrl}} plus their path. The environment's base URL answers {{baseUrl}}, so one request runs against each environment you pick. Every import can be undone from Import history, or from the "Undo import" button Browser sync shows after it finishes.

A project with no requests yet says "Add the first request" and offers "Add a request" and "Import…"; "Import…" opens the same ways in. The cURL command is under "More ways to start".

My workspace and Shared with me

• "My workspace" holds what you own in your Personal Workspace, with its folders.
• "Shared with me" holds personal projects and folders other people shared with you. A shared folder keeps its visible hierarchy; unrelated siblings stay private.
• In an organization, the rail is one tree of teams, sub-teams and projects open to you. Click a team to see all its requests as one list and run them together. A private project carries a Private mark.
• Drag a project onto a team, or use its "Move" button, to file it under that team; that needs Manage on the project. Filing can change who can open it - see /help/api-testing/permissions-sharing.

Good to know

• You can move and rename folders and projects. A folder must be empty before you delete it. Moving shared content can change which permissions are inherited.
• Deleting a request hides it but keeps its history. "Deleted requests" in the project's … menu shows who deleted what, with "Restore", which needs Edit on the project.
• "Delete project" removes the project and its requests, needs Manage, and asks once. Recorded runs are kept as evidence, and monitors and verifications for its requests stop.
• What happens next: "Delete project" removes the project and its requests but keeps recorded runs as evidence. Restoring a request brings it back with its history.

If something goes wrong

• A folder cannot be deleted: it is not empty. Move or delete what is inside first.
• A request disappeared: look under "Deleted requests" and press "Restore".
• You cannot move a project: you need Manage on it.
• "A folder needs a name." and "A project needs a name."
• "A folder cannot be moved into itself." and "A folder cannot be moved into one of its own subfolders."
• "A team project has to be created in an organization workspace." and "Only an organization's project can belong to a team.": switch to the organization first.
• "An organization's project can't be filed into a personal folder."

Related

• /help/api-testing/permissions-sharing
• /help/api-testing/har-and-openapi-imports
• /help/settings/browser-sync-recording