How to Test Our API Using REST Clients

What Are REST Clients?

REST clients are tools that make it easier to send HTTP requests to APIs. They allow developers to explore, test, and integrate endpoints in a practical and interactive way—without needing to write code manually.

These tools are especially useful for validating API calls, testing different flows, and debugging integrations.

Recommended Tools

Postman

Postman is one of the most popular tools for API testing. It offers a user-friendly interface, support for variables, automated testing, and much more.

Insomnia

Insomnia is a lightweight and powerful alternative focused on simplicity, performance, and advanced support for environments and authentication.

Download Pipefy's GraphQL API Collection

Click here to download our GraphQL API collection in JSON format.

How to Import the Collection

In Postman:

Open Postman
Click “Import” in the top left corner
Select the “File” tab
Choose the .json file you downloaded
Click “Import”.

In Insomnia:

Open Insomnia.
Go to “Application” → “Preferences”.
Navigate to the “Data” tab and click “Import Data”.
Select “From File” and upload the .json file.
The collection will be imported into your workspace.