curl --request POST \
--url https://developer.synq.io/api/context-entries/v1alpha/entities \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"entityIds": [
"<string>"
],
"kinds": []
}
'import requests
url = "https://developer.synq.io/api/context-entries/v1alpha/entities"
payload = {
"entityIds": ["<string>"],
"kinds": []
}
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({entityIds: ['<string>'], kinds: []})
};
fetch('https://developer.synq.io/api/context-entries/v1alpha/entities', 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://developer.synq.io/api/context-entries/v1alpha/entities",
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([
'entityIds' => [
'<string>'
],
'kinds' => [
]
]),
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 := "https://developer.synq.io/api/context-entries/v1alpha/entities"
payload := strings.NewReader("{\n \"entityIds\": [\n \"<string>\"\n ],\n \"kinds\": []\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("https://developer.synq.io/api/context-entries/v1alpha/entities")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"entityIds\": [\n \"<string>\"\n ],\n \"kinds\": []\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://developer.synq.io/api/context-entries/v1alpha/entities")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"entityIds\": [\n \"<string>\"\n ],\n \"kinds\": []\n}"
response = http.request(request)
puts response.read_body{
"entities": [
{
"entityId": "<string>",
"entries": [
{
"id": "<string>",
"entityId": "<string>",
"text": "<string>",
"kind": "CONTEXT_ENTRY_KIND_UNSPECIFIED",
"target": {
"entityId": "<string>"
},
"endsAt": "2023-01-15T01:30:15.01Z",
"origin": "CONTEXT_ENTRY_ORIGIN_UNSPECIFIED",
"etag": "<string>",
"createdBy": {
"name": "<string>",
"email": {
"userEmail": "jsmith@example.com"
},
"via": "VIA_UNSPECIFIED"
},
"updatedBy": {
"name": "<string>",
"email": {
"userEmail": "jsmith@example.com"
},
"via": "VIA_UNSPECIFIED"
},
"createdAt": "2023-01-15T01:30:15.01Z",
"updatedAt": "2023-01-15T01:30:15.01Z"
}
],
"omittedCount": 123
}
],
"queriesComputedAt": "2023-01-15T01:30:15.01Z"
}BatchGetEntityContextEntries
For each entity, list the context entries that apply to it now.
The response has one entry per requested id, in the order you asked. An entity that no entry applies to comes back with an empty list. Ended entries are left out.
An entry that targets an entity applies to that exact entity id. An entry with a query applies to every entity the query selects, including the other representations of the same table (a transformation model and the warehouse table it builds).
curl --request POST \
--url https://developer.synq.io/api/context-entries/v1alpha/entities \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"entityIds": [
"<string>"
],
"kinds": []
}
'import requests
url = "https://developer.synq.io/api/context-entries/v1alpha/entities"
payload = {
"entityIds": ["<string>"],
"kinds": []
}
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({entityIds: ['<string>'], kinds: []})
};
fetch('https://developer.synq.io/api/context-entries/v1alpha/entities', 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://developer.synq.io/api/context-entries/v1alpha/entities",
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([
'entityIds' => [
'<string>'
],
'kinds' => [
]
]),
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 := "https://developer.synq.io/api/context-entries/v1alpha/entities"
payload := strings.NewReader("{\n \"entityIds\": [\n \"<string>\"\n ],\n \"kinds\": []\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("https://developer.synq.io/api/context-entries/v1alpha/entities")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"entityIds\": [\n \"<string>\"\n ],\n \"kinds\": []\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://developer.synq.io/api/context-entries/v1alpha/entities")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"entityIds\": [\n \"<string>\"\n ],\n \"kinds\": []\n}"
response = http.request(request)
puts response.read_body{
"entities": [
{
"entityId": "<string>",
"entries": [
{
"id": "<string>",
"entityId": "<string>",
"text": "<string>",
"kind": "CONTEXT_ENTRY_KIND_UNSPECIFIED",
"target": {
"entityId": "<string>"
},
"endsAt": "2023-01-15T01:30:15.01Z",
"origin": "CONTEXT_ENTRY_ORIGIN_UNSPECIFIED",
"etag": "<string>",
"createdBy": {
"name": "<string>",
"email": {
"userEmail": "jsmith@example.com"
},
"via": "VIA_UNSPECIFIED"
},
"updatedBy": {
"name": "<string>",
"email": {
"userEmail": "jsmith@example.com"
},
"via": "VIA_UNSPECIFIED"
},
"createdAt": "2023-01-15T01:30:15.01Z",
"updatedAt": "2023-01-15T01:30:15.01Z"
}
],
"omittedCount": 123
}
],
"queriesComputedAt": "2023-01-15T01:30:15.01Z"
}Authorizations
Body
Only entries of these kinds. Empty means every kind.
The kind of a context entry. The kind decides where a person sees the entry in the app. It does not decide who reads it: people and agents read every kind.
CONTEXT_ENTRY_KIND_UNSPECIFIED, CONTEXT_ENTRY_KIND_ANNOUNCEMENT, CONTEXT_ENTRY_KIND_DESCRIPTION, CONTEXT_ENTRY_KIND_GUIDANCE Response
Success
When the selections of the entries with a query were last computed. Unset when the workspace has no such entry, or before the first computation. An entry with a query that was created or changed after this time is not yet in the response.
"2023-01-15T01:30:15.01Z"
"2024-12-25T12:00:00Z"