API overview

The Qall API is REST over HTTPS and returns JSON. Everything lives under /api.

https://qall.io

Authenticating

Send an API key as a bearer token.

curl https://qall.io/api/assistants \
  -H "Authorization: Bearer $QALL_API_KEY"

import os, requests

response = requests.get(
    "https://qall.io/api/assistants",
    headers={"Authorization": f"Bearer {os.environ['QALL_API_KEY']}"},
    timeout=30,
)
response.raise_for_status()

Your key acts with the permissions of the person who created it, in their organisation. Everything you read and write is scoped to that organisation.

What you can do


Assistants	Create and configure them, attach tools, knowledge and playbooks
Calls	List, filter, read transcripts, download recordings, export
Contacts	Create, update, search, manage custom properties
Campaigns	Create, import contacts, start, pause, read progress
Tools and playbooks	Full management, including test runs
Knowledge	Upload documents and attach them
Analytics	Run charts and export results
Web calls	Start a browser call from your own front end

Browse every endpoint under Endpoints. Some of the dashboard has no API: creating API keys, billing, your own profile, and organisation membership are session-only, by design.

Responses

Most endpoints wrap the result:

{ "success": true, "message": "OK", "data": { } }

Assistant endpoints return the object directly instead, and the calls endpoints have their own shape. Each endpoint page shows exactly what it returns, generated from the server — trust that over any general rule.

Pagination

List endpoints take page and per_page.

Contacts takes page_size rather than per_page. Sending per_page there is ignored and you’ll get the default page size.

Filtering

Many list endpoints let you repeat a filter to widen it, while different filters narrow:

?status=completed&status=failed&direction=inbound

reads as inbound, and either completed or failed.

Getting told about calls

Rather than polling for new calls, register a webhook and have Qall notify you.

Using the API

Webhooks

Endpoints

API overview

Authenticating

What you can do

Responses

Filtering

Getting told about calls

​Authenticating

​What you can do

​Responses

​Pagination

​Filtering

​Getting told about calls

Authenticating

What you can do

Responses

Pagination

Filtering

Getting told about calls