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

# Postman

> Getting started with the Omneo Postman collection for API exploration.

The Omneo Postman collection is the fastest way to explore the API, test endpoints, and verify your integration setup.

## Prerequisites

* [Download Postman](https://www.postman.com/downloads/) for your operating system
* Your Omneo tenant name and API credentials

## Step 1: Request the Omneo Postman collection

Contact [Omneo support](mailto:support@omneo.io) to request the latest Omneo Postman collection (`omneo_api.json`).

## Step 2: Import the collection

1. Open Postman
2. Select **Import** in the top bar
3. Select **Upload Files**
4. Select the `omneo_api.json` file provided by Omneo support
5. Select **Import**

## Step 3: Configure environment variables

1. Select the environment selector (top right) → **Add Environment**
2. Add the variable `baseUrl` with the value of your Omneo API URL:
   ```
   https://api.[tenant].getomneo.com/api/v3
   ```
3. Select **Update**

## Step 4: Authenticate

### Using a bearer token (recommended for quick start)

1. Select any request → **Authorization** tab
2. Set **Type** to **Bearer Token**
3. Paste your token from CX Manager (Settings → API Tokens)

### Using OAuth 2.0

1. Select any request → **Authorization** tab
2. Set **Type** to **OAuth 2.0**
3. Configure with these settings:
   * **Grant Type:** Password Credentials
   * **Access Token URL:** `https://api.{tenant}.getomneo.com/api/v3/auth/token`
   * **Client ID/Secret:** From your Omneo Administrator
   * **Username/Password:** Your CX Manager credentials
   * **Scope:** `*`
   * **Client Authentication:** Send client credentials in Body
4. Select **Get New Access Token**

## Step 5: Make your first request

1. Select the **Browse Profiles GET** request
2. Set your authentication
3. Select **Send**

A successful response returns a paginated list of profiles.

## Troubleshooting

| Error              | Cause                    | Fix                                     |
| ------------------ | ------------------------ | --------------------------------------- |
| `401 Unauthorized` | Invalid or missing token | Check authentication configuration      |
| `ENOTFOUND`        | Wrong base URL           | Verify `baseUrl` environment variable   |
| Empty response     | Correct URL, no data     | Your instance may not have profiles yet |

## Path variables

For endpoints requiring IDs (e.g., `/profiles/:profileId`), set the variable in the **Params** tab under **Path Variables**.