Appearance
Quickstart
This guide walks you through your first request: create it, send it, read the response and save your changes. It takes about five minutes.
You need a Collapy account. If you don't have one yet, see Create an account.
1. Create a request
Sign in at app.collapy.com. You start in your Personal workspace.
Open a new request form in one of these ways:
- In the EXPLORER panel header, click + (New Request).
- In the tab bar, click + and choose New Request.
- If no tabs are open, click New Request on the Welcome to Collapy screen.
A New Request tab opens.
2. Fill in the basics
Type a name in the Request title field, for example
Get user.Optional: click the collection row (it shows None (Root level)) to put the request in a collection. You can skip this and move it later.
Pick a method from the drop-down at the left of the URL bar.
GETis selected by default.Enter the URL in the URL bar, for example:
https://api.example.com/users/42Replace it with an endpoint from your own API. Collapy needs a full URL starting with
http://orhttps://.Click Create in the toolbar.
The request is saved to the workspace and appears in the EXPLORER. The toolbar now shows Save and Send.
3. Send it
Click Send, or press Ctrl+Enter (Cmd+Enter on macOS).
The button changes to Sending... while Collapy waits for the server.
4. Read the response
The response appears in the RESPONSE panel at the bottom of the screen. At the top you see:
- the status code, such as
200 - how long the request took, such as
184ms - the size of the response, such as
1.42KB
Below that, the Body tab shows the response body. Switch between Pretty and Raw to change how it's displayed. The Headers tab lists the response headers.
If something went wrong, such as a typo in the host name, the panel shows the error instead.
Every send is also recorded as an execution, which your teammates can see in the EXECUTIONS panel.
5. Change and save
Edit the request: add a query parameter on the Params tab or a header on the Headers tab. The tab title shows that you have unsaved changes, and the footer counts them (for example 1 unsaved).
Send always uses what's on screen, so you can try changes before saving them.
To keep your changes, click Save or press Ctrl+S (Cmd+S on macOS). The footer goes back to All saved, and everyone in the workspace now sees the updated request.
Next steps
- Use variables. Create an environment with a
baseUrlvariable and write{{baseUrl}}/users/42, so the same request works against development and production. See Environments and Variables. - Organize your requests into collections. See Collections and the Explorer.
- Bring your existing work over from Postman. See Import from Postman.
- Invite your team. See Members and roles.