List proposals
curl --request GET \
--url https://api.journeybee.io/v1/proposals/ \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.journeybee.io/v1/proposals/"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.journeybee.io/v1/proposals/', 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.journeybee.io/v1/proposals/",
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 := "https://api.journeybee.io/v1/proposals/"
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("https://api.journeybee.io/v1/proposals/")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.journeybee.io/v1/proposals/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": [
{
"uuid": "<string>",
"version": 123,
"state": "draft",
"canonical_action": {
"source": "internal",
"name": "<string>",
"operationId": "<string>",
"method": "GET",
"surface": "admin"
},
"input_digest": "<string>",
"input": {},
"risk_class": "read",
"approval_policy": "none",
"rationale": "<string>",
"conversation_uuid": "<string>",
"outcome": {},
"error_summary": "<string>",
"execution_run_uuid": "<string>",
"proposed_by_uuid": "<string>",
"canceled_by_uuid": "<string>",
"cancel_reason": "<string>",
"source_host": "buzz",
"expires_at": "<string>",
"proposed_at": "<string>",
"decided_at": "<string>",
"started_at": "<string>",
"completed_at": "<string>",
"parent_uuid": "<string>",
"batch_seq": 123,
"input_scrubbed_at": "<string>",
"presentation": {
"title": "<string>",
"body": "<string>",
"entity_refs": [
{
"kind": "<string>",
"ref": "<string>",
"label": "<string>"
}
],
"presentation_verification": {
"kind": "canonical_generic_wrapper",
"descriptor": "archive_task",
"version": 1,
"targets": [
{
"kind": "<string>",
"ref": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
]
}
},
"batch": {
"children": [
{
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"batch_seq": 0,
"version": 0,
"state": "draft",
"included": true,
"outcome": "pending"
}
],
"progress": {
"total": 0,
"included": 0,
"succeeded": 0,
"failed": 0,
"skipped": 0,
"canceled": 0,
"outcome_unknown": 0,
"pending": 0
}
},
"children": [
{
"uuid": "<string>",
"version": 123,
"state": "draft",
"canonical_action": {
"source": "internal",
"name": "<string>",
"operationId": "<string>",
"method": "GET",
"surface": "admin"
},
"input_digest": "<string>",
"input": {},
"risk_class": "read",
"approval_policy": "none",
"rationale": "<string>",
"conversation_uuid": "<string>",
"outcome": {},
"error_summary": "<string>",
"execution_run_uuid": "<string>",
"proposed_by_uuid": "<string>",
"canceled_by_uuid": "<string>",
"cancel_reason": "<string>",
"source_host": "buzz",
"expires_at": "<string>",
"proposed_at": "<string>",
"decided_at": "<string>",
"started_at": "<string>",
"completed_at": "<string>",
"parent_uuid": "<string>",
"batch_seq": 123,
"input_scrubbed_at": "<string>",
"presentation": {
"title": "<string>",
"body": "<string>",
"entity_refs": [
{
"kind": "<string>",
"ref": "<string>",
"label": "<string>"
}
],
"presentation_verification": {
"kind": "canonical_generic_wrapper",
"descriptor": "archive_task",
"version": 1,
"targets": [
{
"kind": "<string>",
"ref": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
]
}
}
}
]
}
],
"pagination": {
"page": 123,
"per_page": 123,
"total": 123,
"total_pages": 123
}
}Proposals
List proposals
List the company’s proposals. API keys, OAuth apps, the Journeybee app’s assistant and the hosted MCP server may call it. The agent scope is advertised for discovery; the action’s own permission is what is enforced.
GET
/
proposals
/
List proposals
curl --request GET \
--url https://api.journeybee.io/v1/proposals/ \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.journeybee.io/v1/proposals/"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.journeybee.io/v1/proposals/', 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.journeybee.io/v1/proposals/",
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 := "https://api.journeybee.io/v1/proposals/"
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("https://api.journeybee.io/v1/proposals/")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.journeybee.io/v1/proposals/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": [
{
"uuid": "<string>",
"version": 123,
"state": "draft",
"canonical_action": {
"source": "internal",
"name": "<string>",
"operationId": "<string>",
"method": "GET",
"surface": "admin"
},
"input_digest": "<string>",
"input": {},
"risk_class": "read",
"approval_policy": "none",
"rationale": "<string>",
"conversation_uuid": "<string>",
"outcome": {},
"error_summary": "<string>",
"execution_run_uuid": "<string>",
"proposed_by_uuid": "<string>",
"canceled_by_uuid": "<string>",
"cancel_reason": "<string>",
"source_host": "buzz",
"expires_at": "<string>",
"proposed_at": "<string>",
"decided_at": "<string>",
"started_at": "<string>",
"completed_at": "<string>",
"parent_uuid": "<string>",
"batch_seq": 123,
"input_scrubbed_at": "<string>",
"presentation": {
"title": "<string>",
"body": "<string>",
"entity_refs": [
{
"kind": "<string>",
"ref": "<string>",
"label": "<string>"
}
],
"presentation_verification": {
"kind": "canonical_generic_wrapper",
"descriptor": "archive_task",
"version": 1,
"targets": [
{
"kind": "<string>",
"ref": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
]
}
},
"batch": {
"children": [
{
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"batch_seq": 0,
"version": 0,
"state": "draft",
"included": true,
"outcome": "pending"
}
],
"progress": {
"total": 0,
"included": 0,
"succeeded": 0,
"failed": 0,
"skipped": 0,
"canceled": 0,
"outcome_unknown": 0,
"pending": 0
}
},
"children": [
{
"uuid": "<string>",
"version": 123,
"state": "draft",
"canonical_action": {
"source": "internal",
"name": "<string>",
"operationId": "<string>",
"method": "GET",
"surface": "admin"
},
"input_digest": "<string>",
"input": {},
"risk_class": "read",
"approval_policy": "none",
"rationale": "<string>",
"conversation_uuid": "<string>",
"outcome": {},
"error_summary": "<string>",
"execution_run_uuid": "<string>",
"proposed_by_uuid": "<string>",
"canceled_by_uuid": "<string>",
"cancel_reason": "<string>",
"source_host": "buzz",
"expires_at": "<string>",
"proposed_at": "<string>",
"decided_at": "<string>",
"started_at": "<string>",
"completed_at": "<string>",
"parent_uuid": "<string>",
"batch_seq": 123,
"input_scrubbed_at": "<string>",
"presentation": {
"title": "<string>",
"body": "<string>",
"entity_refs": [
{
"kind": "<string>",
"ref": "<string>",
"label": "<string>"
}
],
"presentation_verification": {
"kind": "canonical_generic_wrapper",
"descriptor": "archive_task",
"version": 1,
"targets": [
{
"kind": "<string>",
"ref": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
]
}
}
}
]
}
],
"pagination": {
"page": 123,
"per_page": 123,
"total": 123,
"total_pages": 123
}
}Authorizations
API key authentication. Use "Bearer <api_key>" or "Api-Key <api_key>".
Query Parameters
Required range:
1 <= x <= 9007199254740991Required range:
1 <= x <= 100Available options:
draft, proposed, approved, executing, succeeded, partially_succeeded, failed, denied, canceled, expired Only proposals from this assistant conversation. The conversation must belong to the calling user; any other returns 404.
Pattern:
^([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)$