---
title: "Using Postman with the Control API"
slug: "using-postman-with-the-control-api"
updated: 2025-12-15T08:12:56Z
published: 2025-12-15T08:12:56Z
---

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

# Using Postman with the Control API

Postman is a popular tool with our customers for interacting with APIs. This article will help you to configure Postman to use the [Workspot Control API](/v1/docs/using-the-workspot-control-api).

## Prerequisites

- Administrative access to Workspot Control.
- Workspot API feature should be enabled.

## Configure Postman

- Create a free Postman account at [https://www.postman.com/postman-account/](https://www.postman.com/postman-account/) if you don’t have one already.
- Login to Postman [https://web.postman.co/](https://web.postman.co/)
- Go to “My Workspace”:

![](https://cdn.us.document360.io/ad9153e1-c8de-4f56-94f2-b717a1fc3a68/Images/Documentation/67ac9d8a-3499-481d-8f89-554904607cef.png)

- Click on “Collections” from the left pane and click on **“+”** to Create a new collection.

![](https://cdn.us.document360.io/ad9153e1-c8de-4f56-94f2-b717a1fc3a68/Images/Documentation/b679cf24-e6b5-48e5-bb98-258942ac4a09.png)

- Select “Blank Collection” and give the new collection a name, such as “Workspot”:

![](https://cdn.us.document360.io/ad9153e1-c8de-4f56-94f2-b717a1fc3a68/Images/Documentation/b3be5a57-816b-4dc0-9b31-42dfb8cfcae5.png)

- Click on “…” and then “Add request,” and give a name to the request, such as “LicenseInfo.”

![](https://cdn.us.document360.io/ad9153e1-c8de-4f56-94f2-b717a1fc3a68/Images/Documentation/9a08698c-5d09-4fef-acbd-bd577f1d73a4.png)

- On the right side a section will open with Params, Authorization Headers, and other Tabs. Click on the Authorization tab and select OAuth2.0:

![](https://cdn.us.document360.io/ad9153e1-c8de-4f56-94f2-b717a1fc3a68/Images/Documentation/73ec2974-15fe-4ac4-a837-9cb7b3768c36.png)

- Go to the Configure New Token section and provide the required details:
  - Enter a convenient name in the Token Name field
  - Select “Grant Type” as “Password Credentials”
  - Set the “Access Token URL”
    - For US Control: [https://api.us.workspot.com/oauth/token](https://api.us.workspot.com/oauth/token) or [https://api.workspot.com/oauth/token](https://api.us.workspot.com/oauth/token)
    - For EU Control: [https://api.eu.workspot.com/oauth/token](https://api.us.workspot.com/oauth/token)
  - Set the “Client ID” and “Client Secret” (click the “Reveal” button to show the full Client Secret) under Control’s Setup > API” page.

![](https://cdn.us.document360.io/ad9153e1-c8de-4f56-94f2-b717a1fc3a68/Images/Documentation/2c20f78b-ceeb-4016-a3c7-d31e94691288.png)
  - Enter the username (Workspot Control administrator email) and the password of the Administrator.

![](https://cdn.us.document360.io/ad9153e1-c8de-4f56-94f2-b717a1fc3a68/Images/Documentation/95f8a0e9-6857-45be-8033-c6fa75ee9631.png)

- Keep the “Scope” field blank and Client authentication to “Send as Basic Auth header”.
- Click “Get New Access Token.”

![](https://cdn.us.document360.io/ad9153e1-c8de-4f56-94f2-b717a1fc3a68/Images/Documentation/5483aaf2-6728-4eae-92af-5bed32b01eea.png)

- Click “Use Token.”

> **Note:**The token will remain valid for 60 minutes, after which you need to click “Get New Access Token” and “Use Token” again.

## Example of Using the Workspot Control API

In a browser, go to the Workspot Control API:

- [https://api.eu.workspot.com:443](https://eu.api.workspot.com/) for customers with Control deployments in the EU region.
- [https://api.us.workspot.com:443](https://us.api.workspot.com/) for customers with Control deployments in the US region.

From the Control API, capture the appropriate commands to paste into Postman:

- Click on “api-controller” to see the list of API commands:

![](https://cdn.us.document360.io/ad9153e1-c8de-4f56-94f2-b717a1fc3a68/Images/Documentation/bcf5f850-ddc6-42bb-b1ff-3694b8c13ed8.png)

- To get the request URL, Click “Try Out” and then “Execute.”

![](https://cdn.us.document360.io/ad9153e1-c8de-4f56-94f2-b717a1fc3a68/Images/Documentation/b99b2697-d294-45b9-a038-7eb96632cb73.png)

![](https://cdn.us.document360.io/ad9153e1-c8de-4f56-94f2-b717a1fc3a68/Images/Documentation/f952e690-2ecf-405f-ab4a-46b521980130.png)

- Copy the Request URL, paste it into the Postman, and click on Send.
- Postman will send the request with the appropriate credentials for your Workspot deployment
- The API will send the response, which will be displayed in the Body section as shown below:

![](https://cdn.us.document360.io/ad9153e1-c8de-4f56-94f2-b717a1fc3a68/Images/Documentation/ae00416b-c2ef-4e83-85db-6a6695418955.png)

## Related Document

[Using the Workspot Control API](/v1/docs/using-the-workspot-control-api).