API Overview

Understand RogerIQ API hosts, authentication, resources, pagination, and public versus dashboard APIs.

API Overview

RogerIQ exposes a public API for server integrations and separate internal dashboard APIs for the app.

Hosts

Host	Use
`https://api.rogeriq.com/api/v1`	Public API-key resources.
`https://api.rogeriq.com/api`	Dashboard, widget, forms, docs, and integration APIs.
`https://rogeriq.com`	Dashboard, hosted forms, public docs routes, marketing pages.

Public API Resources

The stable public API currently covers:

conversations
messages
contacts
webhooks
webhook delivery history

Public forms and beacons also expose unauthenticated browser-safe endpoints under /api, documented in Forms and beacons.

Authentication

Public API calls require a riq_ API key.

bash
curl https://api.rogeriq.com/api/v1/projects/prj_123/contacts \  -H "Authorization: Bearer riq_your_key"

Response Shape

Single-resource responses usually return:

json
{  "data": {    "id": "..."  }}

Paginated responses return:

json
{  "data": [],  "cursor": null,  "has_more": false}

Project Scope

Most public API paths include projectId. The API key must belong to the organization that owns that project.

txt
/api/v1/projects/:projectId/...

The generated OpenAPI endpoint currently requires an API key on the live API host. This docs site includes a local OpenAPI file so the reference remains available to readers and HolyDocs.

Was this page helpful?

Previous HolyDocs Integration

Next API Authentication