API reference
Postman collection
Try every Quenza API endpoint in Postman without writing code. Download the collection, add your API token and send your first request.
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
Section titled “Import the collection”- Download the collection with the button above.
- In Postman, open your workspace and click Use resources or import, then the Import tab.
- Drop the file into the window. Quenza API appears under Collections in the sidebar.
Postman’s own guide, Import data into Postman, shows the same steps. Postman updates its app often, so its screens may differ a little.
Add your API token
Section titled “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.
- In Postman, select the Quenza API collection and open its Variables tab.
- Paste your token as the value of
token. Postman saves it by itself.
Send a request
Section titled “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.
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.
Keep it up to date
Section titled “Keep it up to date”The collection is built from this reference, so it always has the endpoints listed here. When What’s 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
Section titled “Insomnia, Bruno and other tools”Insomnia and Bruno import the same file. Other tools and code generators read the OpenAPI file, which describes every endpoint and field of the public API. Use it, for example, to generate a client library for your language.
Was this article helpful?
Thanks for letting us know.
Thank you. We read every answer and use it to improve this article.