# Postman collection

> Try every Quenza API endpoint in Postman without writing code. Download the collection, add your API token and send your first request.

Source: https://quenza.com/help/api/postman/

Postman lets you send API requests from a window instead of from code. It is the quickest way to see what the Quenza API returns for your workspace before you build an integration. One file holds every endpoint of this reference, so you download it once.

The collection has a folder per topic, such as Clients and Members. Every request comes with the right headers, the example body from this reference and an example response, so you can compare what you get with what you should get. Each request's description links its page in this reference.

## Import the collection

1. Download the collection with the button above.
2. In Postman, open your workspace and click **Use resources or import**, then the **Import** tab.
3. Drop the file into the window. **Quenza API** appears under **Collections** in the sidebar.

Postman's own guide, [Import data into Postman](https://learning.postman.com/docs/getting-started/importing-and-exporting/importing-data), shows the same steps. Postman updates its app often, so its screens may differ a little.

## Add your API token

Every request in the collection uses the collection variable `token`. A workspace Owner or Manager creates the token under **Developer Tools → API Token**; see [Authentication](https://quenza.com/help/api/authentication/).

1. In Postman, select the **Quenza API** collection and open its **Variables** tab.
2. Paste your token as the value of `token`. Postman saves it by itself.

> **Caution:** The token gives full API access to your workspace. Postman keeps a variable's value on your computer unless you click **Share** next to it, so don't share it, and don't export the collection with the token in it.

## Send a request

Open **Clients → List clients** and click **Send**. Postman shows the clients of your workspace as JSON, with `data`, `meta` and `links` as described in [Pagination](https://quenza.com/help/api/pagination/).

Requests for one record, such as **Get a client**, have the ID in the address as `:client`. Postman fills it with an example ID from this reference; replace it on the request's **Params** tab with an ID from your own list, or you get a `404`.

> **Caution:** The collection works on your real workspace. **Create a client** and **Create a member** send invitation emails, and a new member uses a seat on your plan. Change the example body to your own test details before you send these requests, and archive test clients afterwards.

## Keep it up to date

The collection is built from this reference, so it always has the endpoints listed here. When [What's new](https://quenza.com/help/whats-new/) announces a new endpoint, download the file again and import it. Then delete the old **Quenza API** collection and add your token to the new one.

## Insomnia, Bruno and other tools

Insomnia and Bruno import the same file. Other tools and code generators read the [OpenAPI file](https://quenza.com/help/api/openapi.json), which describes every endpoint and field of the public API. Use it, for example, to generate a client library for your language.
