---
title: "REST Client Sample API Requests"
slug: "rest-client-sample-api-requests"
description: "Explore Pigment's API sample collection, easily importable into REST clients, and learn to use environment variables for seamless integration."
tags: ["API Calls", "Environment Variables", "Importing Exporting Data", "JSON File"]
updated: 2025-08-29T09:18:40Z
published: 2025-08-29T09:18:40Z
---

> ## Documentation Index
> Fetch the complete documentation index at: https://kb.pigment.com/llms.txt
> Use this file to discover all available pages before exploring further.

# REST Client Sample API Requests

Pigment provides a sample collection of all currently available API calls in a format that can be imported into a variety of REST clients.

Pigment’s sample collection is available in the JSON file [here](https://storage.googleapis.com/public-customer-resources/rest-api-samples/Pigment-API-Collection.json).

## **Importing The Collection**

Within your REST client of choice, select **import** and choose the file provided above. Your client may guide you through a wizard or configuration as part of this process. Once complete, you’ll see a folder structure similar to the image below.

![](https://cdn.document360.io/e47cfe35-dc28-40c7-a083-6cf003073d8e/Images/Documentation/a4d59389-f0c2-4747-971b-537262513d4e.png)

> [!NOTE]
> ℹ️ **Note**
> 
> The JSON file provided above has been tested with Postman and Insomnia. Other clients may need a conversion in order to accept the file.

## **Using Environment Variables**

This collection has been built to utilize the environment variables feature that some REST clients offer. You are free to continue using it, or use with your own values by replacing all of the placeholders denoted with a `{{` and `}}` e.g. `{{._API_KEY}}`.

To get started, read your client’s documentation on how to use and create environment variables.

> [!WARNING]
> **⚠️**Important
> 
> The Pigment public API enforces rate limits to ensure fair usage. The limit is 500 requests per 5-minute window per IP address. For more information, see [Rate Limits for Pigment Public API](/v1/docs/rate-limits-for-pigment-public-api).

`CONFIGURATION_ID` - Used in import data call. This value is set up within the Pigment UI as part of the import configuration process.

`IMPORT_API_KEY` - An API key with the import permission.

`EXPORT_API_KEY` - An API key with the export permission.

`SCIM_API_KEY` - An API key with the user management permission.

`VIEW_ID` - Used in exporting table, list and metric data. A value in the page URL when viewing the block you want to export.

`IMPORT_ID` - An ID returned from the import API. Used to query the status of an import.

`SCIM_USER_ID` - An ID of a user obtained either through creating or querying users through the SCIM API.

> [!TIP]
> 🎓 **Resources**
> 
> Not sure where to find these values? There’s a detailed guide available [here for exports](/v1/docs/export-data-with-apis), [here for imports](/v1/docs/trigger-import-apis) and [here for the SCIM API](/v1/docs/manage-scim-domain-restriction ).