The Omneo Postman collection is the fastest way to explore the API, test endpoints, and verify your integration setup.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.
Prerequisites
- Download Postman for your operating system
- Your Omneo tenant name and API credentials
Step 1: Clone the Omneo DevTools
Step 2: Import the collection
- Open Postman
- Click the Import button in the top bar
- Select Upload Files
- Navigate to the cloned repo and select
omneo_api.json - Click Import
Step 3: Configure environment variables
- Click the environment selector (top right) → Add Environment
- Add the variable
baseUrlwith the value of your Omneo API URL: - Click Update
Step 4: Authenticate
Using a bearer token (recommended for quick start)
- Select any request → Authorization tab
- Set Type to Bearer Token
- Paste your token from CX Manager (Settings → API Tokens)
Using OAuth 2.0
- Select any request → Authorization tab
- Set Type to OAuth 2.0
- Configure with these settings:
- Grant Type: Password Credentials
- Access Token URL:
https://api.{{YOUR-TENANT-NAME}}.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
- Click Get New Access Token
Step 5: Make your first request
- Select the Browse Profiles GET request
- Set your authentication
- Click Send
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.