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

# Upmind API Guide: Generating API Tokens

> How to generate API tokens for all your needs while using a perfect flow of your business.

Upmind is API-first, meaning every feature in the system is accessible through its API. This guide will walk you through generating an API token in the Upmind admin area. With this token, you can securely connect Upmind to your custom applications or services.

## How to create an API token in Upmind

1. Log in to your Upmind admin area.
2. Go to **Settings** > **API Tokens**.

<Frame caption="Settings > API Tokens">
  <img src="https://mintcdn.com/upmind/c5sDUwEs8YpzGbjA/images/fb/9df408a217cc6fec.png?fit=max&auto=format&n=c5sDUwEs8YpzGbjA&q=85&s=ec6c183d5c1ef0c8022f8859b59da6dd" alt="Settings > API Tokens" className="mx-auto" style={{ width:"98%" }} data-og-width="2872" width="2872" data-og-height="1288" height="1288" data-path="images/fb/9df408a217cc6fec.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/upmind/c5sDUwEs8YpzGbjA/images/fb/9df408a217cc6fec.png?w=280&fit=max&auto=format&n=c5sDUwEs8YpzGbjA&q=85&s=1d073f6a74a20368d4cc991d93ad7808 280w, https://mintcdn.com/upmind/c5sDUwEs8YpzGbjA/images/fb/9df408a217cc6fec.png?w=560&fit=max&auto=format&n=c5sDUwEs8YpzGbjA&q=85&s=a06a55bc436511f355962b0021df57fc 560w, https://mintcdn.com/upmind/c5sDUwEs8YpzGbjA/images/fb/9df408a217cc6fec.png?w=840&fit=max&auto=format&n=c5sDUwEs8YpzGbjA&q=85&s=8dadfbe39e13928612cb21e816087491 840w, https://mintcdn.com/upmind/c5sDUwEs8YpzGbjA/images/fb/9df408a217cc6fec.png?w=1100&fit=max&auto=format&n=c5sDUwEs8YpzGbjA&q=85&s=e7c45101ba1a011986edc0d87666266b 1100w, https://mintcdn.com/upmind/c5sDUwEs8YpzGbjA/images/fb/9df408a217cc6fec.png?w=1650&fit=max&auto=format&n=c5sDUwEs8YpzGbjA&q=85&s=16b211abea2dc01f830bf6a09d023f17 1650w, https://mintcdn.com/upmind/c5sDUwEs8YpzGbjA/images/fb/9df408a217cc6fec.png?w=2500&fit=max&auto=format&n=c5sDUwEs8YpzGbjA&q=85&s=ddcff5ea99f9eb6934216c871b4247d1 2500w" />
</Frame>

3. Click **Create API Token** to create a new token. In the pop-up window:
   * Enter a descriptive name for your token.
   * Add an IP Whitelist for security.
   * Set up user permissions as needed.

<Frame caption="Create API Token">
  <img src="https://mintcdn.com/upmind/Dgjmf3QWYVBR40cE/images/fb/62db6764629fcbde.png?fit=max&auto=format&n=Dgjmf3QWYVBR40cE&q=85&s=c0def70c86f0d1f521a1da1b63a4bd78" alt="Create API Token" className="mx-auto" style={{ width:"98%" }} width="2286" height="302" data-path="images/fb/62db6764629fcbde.png" />
</Frame>

<Frame caption="Add name and choose permissions">
  <img src="https://mintcdn.com/upmind/wRuKrNY12tQZY8Rr/images/fb/30b1f4d7a1de39d1.png?fit=max&auto=format&n=wRuKrNY12tQZY8Rr&q=85&s=119c628d18c90623074b7fe973f0d235" alt="Add name and choose permissions" className="mx-auto" style={{ width:"92%" }} width="1566" height="1524" data-path="images/fb/30b1f4d7a1de39d1.png" />
</Frame>

<Frame caption="Add IP whitelist">
  <img src="https://mintcdn.com/upmind/FQ1NhxALxjSHvvWW/images/fb/ae18b1a268e178b2.png?fit=max&auto=format&n=FQ1NhxALxjSHvvWW&q=85&s=648b8dfe76da8eb0a72e7c3a0edd3244" alt="Add IP whitelist" className="mx-auto" style={{ width:"94%" }} width="1562" height="892" data-path="images/fb/ae18b1a268e178b2.png" />
</Frame>

4. Click **Save** to generate the API token.

## Managing API tokens

In the API Tokens section, you can:

* Filter tokens by status (active, inactive, revoked).
* Filter by IP whitelist, Whitelisted IPs, and Date created.

<Frame caption="API token filters">
  <img src="https://mintcdn.com/upmind/h8h5zREaX7k8Y-3x/images/fb/149546c86b2a5913.png?fit=max&auto=format&n=h8h5zREaX7k8Y-3x&q=85&s=571c9ec966ba928a1d01679973522a9d" alt="API token filters" className="mx-auto" style={{ width:"95%" }} width="2074" height="768" data-path="images/fb/149546c86b2a5913.png" />
</Frame>

* For each generated API token, you can:
  * Toggle off to deactivate the token.
  * Manage token settings.
  * View the activity log.
  * Refresh the token for security purposes.
  * Revoke the token when it is no longer needed.

<Frame caption="API token options">
  <img src="https://mintcdn.com/upmind/Dgjmf3QWYVBR40cE/images/fb/59cf1ed2e6dee396.png?fit=max&auto=format&n=Dgjmf3QWYVBR40cE&q=85&s=aff58720d081910dc9f48b62fcaccbf8" alt="API token options" className="mx-auto" style={{ width:"92%" }} width="1982" height="1288" data-path="images/fb/59cf1ed2e6dee396.png" />
</Frame>

## Using the API and SDK

For further details on utilising Upmind SDK, please check our [GitHub repository](https://github.com/upmind/sdk-php?tab=readme-ov-file#usage).

<Warning>
  When the flag `without_notifications` is passed in the request as **True**, it will stop notifications only, not webhooks.
</Warning>

Our comprehensive [API documentation](https://demoapi.upmind.io/doc/) includes all available endpoints and functionalities.
