1. Home
  2. Docs
  3. Private: Rali APIs
  4. API Overview

API Overview

The API provides the following calls in the https://api.onq.io/api/external namespace:

Endpoint Description
/conversations Find, filter, sort, and paginate conversation data
/events Find, filter, sort, and paginate events data


Authorization Header

An Authorization header is required to access APIs. If you do not pass a valid bearer token in the Authorization header, you will get a 401 authorization HTTP error.  Review the onQ API Authentication to learn how to generate authentication tokens.

Once the token is generated, use it as an Authorization: Bearer {token} header in your requests to onQ.

Error codes

API returns HTTP errors codes when there is an issue. Here are the following codes:

401 – Unauthorized
403 – Invalid API request
404 – API endpoint not found
500 – Server error


Was this article helpful to you? Yes No

How can we help?