curl --request GET \
--url http://localhost:3000/rs/inbox-items/v1/ \
--header 'Authorization: Bearer <token>'import requests
url = "http://localhost:3000/rs/inbox-items/v1/"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('http://localhost:3000/rs/inbox-items/v1/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/rs/inbox-items/v1/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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 := "http://localhost:3000/rs/inbox-items/v1/"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("http://localhost:3000/rs/inbox-items/v1/")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/rs/inbox-items/v1/")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"inboxMailId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "unknown",
"status": "pending",
"file": {
"name": "<string>",
"mimeType": "<string>",
"size": 536870912,
"storageKey": "<string>"
},
"classifyParked": true,
"reportId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"processedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"inboxMail": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"source": "email",
"fromEmail": "jsmith@example.com",
"subject": "<string>",
"receivedAt": "2023-11-07T05:31:56Z"
},
"actions": {
"canBeDismissed": true,
"canBeDeleted": true,
"canBecomeReport": true
},
"downloadUrl": "<string>",
"latestAnalysis": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"step": "metadata",
"status": "pending",
"error": "<string>",
"startedAt": "2023-11-07T05:31:56Z",
"finishedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"proposal": {
"provider": {
"label": "<string>",
"confidence": 0.5
},
"unit": {
"label": "<string>",
"confidence": 0.5
}
},
"reportType": "pv",
"metadataAnalysisId": "<string>"
},
"senderProvider": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
},
"report": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ref": "<string>",
"name": "<string>",
"unit": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
}
}
}
],
"totalCount": 4503599627370495,
"pagination": {
"page": 4503599627370495,
"pageSize": 4503599627370495,
"totalPages": 4503599627370495
}
}{
"error": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}{
"error": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}{
"error": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}List the things to process received by mail
curl --request GET \
--url http://localhost:3000/rs/inbox-items/v1/ \
--header 'Authorization: Bearer <token>'import requests
url = "http://localhost:3000/rs/inbox-items/v1/"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('http://localhost:3000/rs/inbox-items/v1/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/rs/inbox-items/v1/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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 := "http://localhost:3000/rs/inbox-items/v1/"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("http://localhost:3000/rs/inbox-items/v1/")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/rs/inbox-items/v1/")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"inboxMailId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "unknown",
"status": "pending",
"file": {
"name": "<string>",
"mimeType": "<string>",
"size": 536870912,
"storageKey": "<string>"
},
"classifyParked": true,
"reportId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"processedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"inboxMail": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"source": "email",
"fromEmail": "jsmith@example.com",
"subject": "<string>",
"receivedAt": "2023-11-07T05:31:56Z"
},
"actions": {
"canBeDismissed": true,
"canBeDeleted": true,
"canBecomeReport": true
},
"downloadUrl": "<string>",
"latestAnalysis": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"step": "metadata",
"status": "pending",
"error": "<string>",
"startedAt": "2023-11-07T05:31:56Z",
"finishedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"proposal": {
"provider": {
"label": "<string>",
"confidence": 0.5
},
"unit": {
"label": "<string>",
"confidence": 0.5
}
},
"reportType": "pv",
"metadataAnalysisId": "<string>"
},
"senderProvider": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
},
"report": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ref": "<string>",
"name": "<string>",
"unit": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
}
}
}
],
"totalCount": 4503599627370495,
"pagination": {
"page": 4503599627370495,
"pageSize": 4503599627370495,
"totalPages": 4503599627370495
}
}{
"error": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}{
"error": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}{
"error": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
0 < x <= 90071992547409910 < x <= 1000When true, answers totalCount with an empty data: the rows are never read, so no extend is selected and no transform runs. For a badge or a counter.
true
Extend options (JSON-encoded array, e.g. ?extend=["category"]):
- "mail": Include the mail this item came out of (door, sender, subject, reception date).
- "actions-info": Adds
actions{ canBeDismissed, canBeDeleted, canBecomeReport }. - "download-url": Adds a presigned
downloadUrlfor the item's file, before any conversion. - "latest-analysis": Newest analysis run of the item (null when it has none), with the provider and unit its succeeded
metadatastep retained and the score each was retained on. - "sender-provider": Provider the sending address belongs to, when exactly one live contact of the organization carries it - the attribution that comes from the mail thread rather than from the document. Null when no contact, or contacts of several providers, answer to that address.
- "report": Report this item became (null while it is still unprocessed), named by its document and placed on the first unit its compliances cover.
mail, actions-info, download-url, latest-analysis, sender-provider, report Show child attributes
Show child attributes
Case-insensitive partial match on the carrying mail's subject or sender address.
200"lobby"
Filter by one or more inbox item ids.
250^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$[
"550e8400-e29b-41d4-a716-446655440000",
"6ba7b810-9dad-11d1-80b4-00c04fd430c8"
]
Filter by what the received document is.
["unknown", "report"]
Filter by processing status - pending is the work queue.
["pending", "processed"]
Filter by the door the document came through - a provider mail, or a manual import.
["email", "import"]
Filter by the mail the items came out of.
250^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$[
"550e8400-e29b-41d4-a716-446655440000",
"6ba7b810-9dad-11d1-80b4-00c04fd430c8"
]
Filter by the sender of the mail (contains, case-insensitive).
200"lobby"
Filter by the reception date of the mail.
- Option 1
- Option 2
Show child attributes
Show child attributes
{
"start": "2026-01-01",
"end": "2026-01-31"
}