curl --request GET \
--url https://api.example.com/api/interactions \
--header 'x-api-key: <api-key>'import requests
url = "https://api.example.com/api/interactions"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.example.com/api/interactions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/interactions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/interactions"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/api/interactions")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/interactions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": {
"items": [
{
"answer_format": "<string>",
"created_at": "<string>",
"format_payload": "<unknown>",
"group_id": "<string>",
"interaction_id": "<string>",
"question": "<string>",
"sensitive": true,
"timeout_at": "<string>",
"audience": "<string>",
"channel": "<string>",
"media": [
{
"kind": "image",
"url": "<string>",
"caption": "<string>",
"filename": "<string>"
}
],
"origin": "<string>",
"recipient": "<string>",
"server_verified": true
}
],
"page": 123,
"page_size": 123,
"total": 123,
"truncated": true,
"next_page": 123
}
}{
"error": "<string>",
"code": "<string>"
}{
"error": "<string>",
"code": "<string>"
}List pending interactions
The pending questions the inbox shows, one page at a time — the initial-load
surface a client reads BEFORE applying the live stream
(GET /api/interactions/stream).
Order is the store’s pending order (each group’s most-recent question created_at,
then stream order within a group). A RESTRICTED caller sees ONLY questions addressed
to its identity — the audience filter runs BEFORE paging so total is honest; an
UNRESTRICTED caller sees every pending question. A page or page_size below 1,
or a page above the served maximum, is a 400; a page_size above the cap is
capped, never refused. The pending read reconciles phantom/abandoned questions as it
goes (phantom-group prune, abandoned past-deadline prune, answered/missing skip). Returns
{"items", "total", "page", "page_size", "next_page", "truncated"} — items
carry the same shape as the stream’s add frames, and truncated is always
false (the pending index is the whole set, sliced in memory).
curl --request GET \
--url https://api.example.com/api/interactions \
--header 'x-api-key: <api-key>'import requests
url = "https://api.example.com/api/interactions"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.example.com/api/interactions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/interactions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/interactions"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/api/interactions")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/interactions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": {
"items": [
{
"answer_format": "<string>",
"created_at": "<string>",
"format_payload": "<unknown>",
"group_id": "<string>",
"interaction_id": "<string>",
"question": "<string>",
"sensitive": true,
"timeout_at": "<string>",
"audience": "<string>",
"channel": "<string>",
"media": [
{
"kind": "image",
"url": "<string>",
"caption": "<string>",
"filename": "<string>"
}
],
"origin": "<string>",
"recipient": "<string>",
"server_verified": true
}
],
"page": 123,
"page_size": 123,
"total": 123,
"truncated": true,
"next_page": 123
}
}{
"error": "<string>",
"code": "<string>"
}{
"error": "<string>",
"code": "<string>"
}Authorizations
Query Parameters
1-based page number, pending order.
1 <= x <= 1000000Items per page. A larger value is capped to 200, never refused.
x >= 1Response
Success.
One page of pending questions. truncated is always false (the pending
index is the whole set, sliced in memory); next_page is null on the
last page.
Show child attributes
Show child attributes

