Omni REST API

REST discovered

Details

URL: https://{instance}.omniapp.co/api
Docs: https://docs.omni.co/api

Authentication

Organization API key api_key discovered Get key ↗

Authorization: Bearer <credential>

An Organization Admin can create this in Omni at API authentication: go to Settings > API access > Organization keys, click Generate new key, enter a descriptive name, click Generate, and copy the key when shown. The secret is only displayed once.

Personal Access Token (PAT) bearer discovered Get token ↗

Authorization: Bearer <credential>

First have an Organization Admin enable personal tokens in API authentication under Settings > API access > Personal tokens. Then a user with Restricted Querier or higher can open their profile and choose Manage account > Generate token to mint a PAT.