Collapy Docs

Appearance

Collections and the Explorer ​

Collections are folders for your requests. They can be nested as deep as you like, and each one can carry its own authentication that the requests inside it inherit. You manage collections and requests in the EXPLORER panel.

The Explorer ​

The EXPLORER shows every collection and request in the current workspace as a tree. Requests can sit inside a collection or directly at the workspace root. Presets, saved variants of a request such as imported Postman examples, appear nested under their request.

ActionHow
Expand or collapse a collectionClick it.
Open a collection's settingsDouble-click it, or right-click → Edit.
Open a requestClick it.
Open the context menuRight-click an item.

Collapy remembers which collections you've expanded in each workspace, so the tree looks the same when you come back. This is saved in your browser on this device, not shared with other members.

The buttons in the EXPLORER header are:

  • the search icon (Search Explorer (Ctrl+Shift+K)): shows or hides the filter box
  • New Collection
  • New Request
  • More actions: Import collection and Clear workspace

Filter the tree ​

  1. Press Ctrl+Shift+K (macOS: Cmd+Shift+K), or click the search icon in the EXPLORER header.
  2. Type in the Filter... box. Collapy matches collection and request names. It ignores case and matches any part of a name.
  3. Use the ↑ and ↓ arrow keys to move through the matches and press Enter to open one. If the match is a collection, Enter expands or collapses it instead.
  4. Press Esc to clear the filter.

If a collection's name matches, Collapy shows everything inside it. If only something inside it matches, Collapy shows just the path down to that match. If nothing matches, click Clear filter.

Create a collection ​

  1. In the EXPLORER header, click New Collection. You can also click + in the tab bar and choose New Collection.
  2. Type a name in Collection name.
  3. Optionally, set up the Auth tab and the description on the Info tab (see below).
  4. Click Create.

A new collection is always created at the top level. To nest it inside another collection, use Move to... afterwards (see Move to...).

To create a request inside a collection, open the collection and click New Request in its toolbar. The new request is placed in that collection.

Collection settings ​

Open a collection to see its settings. The toolbar shows the collection's name, plus Save, New Request, a pin button and a menu with Pin/Unpin, Duplicate and Delete. Changes aren't saved until you click Save or press Ctrl+S (macOS: Cmd+S).

Rename a collection by clicking its name in the toolbar, or by pressing F2 while the collection's tab is active. Then press Save. F2 works the same way for requests and environments.

Auth tab ​

Set the authentication that requests in this collection use when they're set to Inherit Auth from Parent. A new collection starts with No Auth. No Auth stops inheritance, so requests inside the collection get no auth from a parent collection or from the workspace. To pass a parent's auth down, set the collection to Inherit Auth from Parent. See Authentication for how inheritance works.

Info tab ​

FieldWhat it does
DescriptionFree-text notes about the collection.
Parent CollectionWhere this collection sits in the tree. Click it to choose another parent, or choose Workspace root. None (Root level) means the collection sits at the top level.
Visibility → PrivateWhen on, the subtitle reads Only you can access this collection. When off, it reads Workspace members can access this collection.
InformationRead-only ID, Parent ID, Created and Updated time.

Private isn't hidden from admins

A private collection is hidden from regular workspace members, but workspace admins and owners can still see and change it. See Members and roles.

Move, duplicate and delete ​

Right-click a collection or request in the EXPLORER for these actions. Collections also have Edit, and both have Pin/Unpin.

Move to... ​

  1. Right-click the item and choose Move to....
  2. Pick the target collection. Collections can also go to Workspace root. Requests can only be moved into a collection. To move a request back to the workspace root, change Collection on its Info tab.
  3. Click Move.

You can't move a collection into itself or into one of its own sub-collections. Dragging and dropping in the tree isn't supported. Use Move to... instead.

Duplicate ​

Choose Duplicate from the context menu, or press Ctrl+D (macOS: Cmd+D) while a request or collection tab is active. The copy is named <name> (Copy).

  • Duplicating a request copies the request into the same collection and opens it in a new tab.
  • Duplicating a collection creates a new, empty collection at the workspace root with the same name and description. Its requests, sub-collections and auth settings are not copied.

Delete ​

  1. Right-click the item and choose Delete.
  2. Confirm in the dialog.
    • For a collection, the dialog shows how many sub-collections and requests will be deleted with it. If the collection contains any requests, type delete to enable the Delete button.
    • For a request, confirm Delete Request.
  3. The item disappears right away and a message with Undo appears. Click Undo within about 8 seconds to get everything back. After that, the delete is permanent.

Clear workspace ​

More actions → Clear workspace deletes every collection and request in the workspace. Environments aren't affected. The dialog lists how many collections and requests will be removed. Type clear to confirm, then click Clear workspace. This can't be undone.

Pinned items ​

Pin the collections and requests you use most so you can reach them without scrolling the tree.

  • To pin an item, right-click it and choose Pin. You can also use the pin button on a collection's toolbar. Choose Unpin to remove it.
  • Pinned items appear in the PINNED panel. Click the search icon (Search Pinned) in its header to filter them.
  • Pins are personal. Other members don't see your pins. They're saved for each workspace and follow you to any device you sign in on.

Press Ctrl+K (macOS: Cmd+K) to open global search. Type in Search collections, requests, environments... to find items by name in the current workspace.

  • Under FILTER BY:, choose Collection, Request or Environment to narrow the results. Click Clear all to reset.
  • Results are grouped into TOP MATCHES and OTHER RESULTS.
  • Use ↑/↓ to move, Enter to open, and Esc to close.

Export ​

Exporting collections isn't available yet.

FAQ ​

Can I drag requests between collections?

No. Use right-click → Move to....

Why don't my requests use the collection's auth after I created a sub-collection?

New collections start with No Auth, and that stops inheritance. Open the sub-collection, go to Auth, and choose Inherit Auth from Parent.

Who can see a private collection?

You, plus the workspace's admins and owners.

Collapy — make the right call. Together.

© Collapy