entity.list
curl --request POST \
--url http://127.0.0.1:8081/v1/rpc/entity.list \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"jsonrpc": "2.0",
"method": "entity.list",
"id": "<string>",
"params": {
"run_id": "<string>",
"flow": "<string>",
"type": "<string>",
"current_state": "<string>",
"limit": 50,
"cursor": "<string>"
}
}
'import requests
url = "http://127.0.0.1:8081/v1/rpc/entity.list"
payload = {
"jsonrpc": "2.0",
"method": "entity.list",
"id": "<string>",
"params": {
"run_id": "<string>",
"flow": "<string>",
"type": "<string>",
"current_state": "<string>",
"limit": 50,
"cursor": "<string>"
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
jsonrpc: '2.0',
method: 'entity.list',
id: '<string>',
params: {
run_id: '<string>',
flow: '<string>',
type: '<string>',
current_state: '<string>',
limit: 50,
cursor: '<string>'
}
})
};
fetch('http://127.0.0.1:8081/v1/rpc/entity.list', 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 => "8081",
CURLOPT_URL => "http://127.0.0.1:8081/v1/rpc/entity.list",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'jsonrpc' => '2.0',
'method' => 'entity.list',
'id' => '<string>',
'params' => [
'run_id' => '<string>',
'flow' => '<string>',
'type' => '<string>',
'current_state' => '<string>',
'limit' => 50,
'cursor' => '<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "http://127.0.0.1:8081/v1/rpc/entity.list"
payload := strings.NewReader("{\n \"jsonrpc\": \"2.0\",\n \"method\": \"entity.list\",\n \"id\": \"<string>\",\n \"params\": {\n \"run_id\": \"<string>\",\n \"flow\": \"<string>\",\n \"type\": \"<string>\",\n \"current_state\": \"<string>\",\n \"limit\": 50,\n \"cursor\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("http://127.0.0.1:8081/v1/rpc/entity.list")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"jsonrpc\": \"2.0\",\n \"method\": \"entity.list\",\n \"id\": \"<string>\",\n \"params\": {\n \"run_id\": \"<string>\",\n \"flow\": \"<string>\",\n \"type\": \"<string>\",\n \"current_state\": \"<string>\",\n \"limit\": 50,\n \"cursor\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://127.0.0.1:8081/v1/rpc/entity.list")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"jsonrpc\": \"2.0\",\n \"method\": \"entity.list\",\n \"id\": \"<string>\",\n \"params\": {\n \"run_id\": \"<string>\",\n \"flow\": \"<string>\",\n \"type\": \"<string>\",\n \"current_state\": \"<string>\",\n \"limit\": 50,\n \"cursor\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"jsonrpc": "2.0",
"id": "<string>",
"result": {
"entities": [
{
"created_at": "2023-11-07T05:31:56Z",
"current_state": "<string>",
"entity_id": "<string>",
"entity_type": "<string>",
"flow_instance": "<string>",
"revision": 1,
"run_id": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"name": "<string>",
"slug": "<string>"
}
],
"next_cursor": "<string>"
}
}Entities
entity.list
List entities with optional filters. Consolidates legacy “instance” and “entity” reads.
Transport: all methods are a single POST /v1/rpc with the method name in the JSON-RPC body. The path shown is a per-method convenience.
POST
/
v1
/
rpc
/
entity.list
entity.list
curl --request POST \
--url http://127.0.0.1:8081/v1/rpc/entity.list \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"jsonrpc": "2.0",
"method": "entity.list",
"id": "<string>",
"params": {
"run_id": "<string>",
"flow": "<string>",
"type": "<string>",
"current_state": "<string>",
"limit": 50,
"cursor": "<string>"
}
}
'import requests
url = "http://127.0.0.1:8081/v1/rpc/entity.list"
payload = {
"jsonrpc": "2.0",
"method": "entity.list",
"id": "<string>",
"params": {
"run_id": "<string>",
"flow": "<string>",
"type": "<string>",
"current_state": "<string>",
"limit": 50,
"cursor": "<string>"
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
jsonrpc: '2.0',
method: 'entity.list',
id: '<string>',
params: {
run_id: '<string>',
flow: '<string>',
type: '<string>',
current_state: '<string>',
limit: 50,
cursor: '<string>'
}
})
};
fetch('http://127.0.0.1:8081/v1/rpc/entity.list', 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 => "8081",
CURLOPT_URL => "http://127.0.0.1:8081/v1/rpc/entity.list",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'jsonrpc' => '2.0',
'method' => 'entity.list',
'id' => '<string>',
'params' => [
'run_id' => '<string>',
'flow' => '<string>',
'type' => '<string>',
'current_state' => '<string>',
'limit' => 50,
'cursor' => '<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "http://127.0.0.1:8081/v1/rpc/entity.list"
payload := strings.NewReader("{\n \"jsonrpc\": \"2.0\",\n \"method\": \"entity.list\",\n \"id\": \"<string>\",\n \"params\": {\n \"run_id\": \"<string>\",\n \"flow\": \"<string>\",\n \"type\": \"<string>\",\n \"current_state\": \"<string>\",\n \"limit\": 50,\n \"cursor\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("http://127.0.0.1:8081/v1/rpc/entity.list")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"jsonrpc\": \"2.0\",\n \"method\": \"entity.list\",\n \"id\": \"<string>\",\n \"params\": {\n \"run_id\": \"<string>\",\n \"flow\": \"<string>\",\n \"type\": \"<string>\",\n \"current_state\": \"<string>\",\n \"limit\": 50,\n \"cursor\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://127.0.0.1:8081/v1/rpc/entity.list")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"jsonrpc\": \"2.0\",\n \"method\": \"entity.list\",\n \"id\": \"<string>\",\n \"params\": {\n \"run_id\": \"<string>\",\n \"flow\": \"<string>\",\n \"type\": \"<string>\",\n \"current_state\": \"<string>\",\n \"limit\": 50,\n \"cursor\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"jsonrpc": "2.0",
"id": "<string>",
"result": {
"entities": [
{
"created_at": "2023-11-07T05:31:56Z",
"current_state": "<string>",
"entity_id": "<string>",
"entity_type": "<string>",
"flow_instance": "<string>",
"revision": 1,
"run_id": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"name": "<string>",
"slug": "<string>"
}
],
"next_cursor": "<string>"
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json

