Appearance
What is Collapy?
Collapy is a collaborative API client. You build HTTP requests, send them and read the responses, much like in Postman. Your team works on the same requests at the same time and sees each other's changes as they happen.
This page explains the building blocks you'll meet in the app.
How Collapy is organized
Everything in Collapy is nested like this:
Organization
└── Workspace
├── Collections (and sub-collections)
│ └── Requests
└── Environments| Concept | What it is |
|---|---|
| Organization | The top level. An organization has a plan (Free, Pro or Ultra) and members. The plan sets the limits for everything inside it. You can belong to several organizations and switch between them in the top bar. |
| Workspace | A shared space for one project or API. It holds collections, requests and environments. Everyone who is a member of the workspace sees the same content. |
| Collection | A folder for requests. Collections can contain sub-collections, and requests inside them can inherit the collection's authentication. |
| Request | One HTTP call: a method, a URL, and optional parameters, headers, authentication and body. A request can be marked Private so only you and the workspace's Admins and Owners can access it. |
Environments and variables
An environment is a named set of variables, such as Development or Production. You write {{baseUrl}} or {{apiKey}} in a request, and Collapy fills in the value from the environment you've selected. Switch environments and the same request goes to a different server.
Variables can be marked secret. Secret values are hidden in the app.
Executions
Every time you press Send, Collapy records an execution: what was sent, the response that came back, how long it took and who sent it. Executions are shared with everyone in the workspace, so a teammate can open the exact response you saw. You'll find them in the EXECUTIONS panel and in the Executions tab of each request.
How many executions are kept depends on your organization's plan.
Working together, live
Collapy keeps every open copy of a workspace in sync. When a teammate creates, renames or saves something, the change appears on your screen without reloading. The footer shows ONLINE while the live connection is active.
There's no merging of edits. If two people change the same request, the last one to save wins.
Your personal organization
The first time you sign in, Collapy creates two things for you:
- a personal organization named after you (for example Jane Doe's Organization), on the Free plan
- a workspace called Personal inside it
You can start working straight away and invite people or create more organizations later. Your personal organization can't be deleted.