Integrations
Read from a connected service
Makes one read-only request to a connected service using the connection’s stored credential, and returns the response with credential-like fields redacted. Only GET requests are made. operation_id comes from the search endpoint; for a service listed with operation_id GET, pass path (relative, starting with /) and optional query instead of params. A failure on the service’s side returns 424 with a sentence saying what to do.
POST
/
api
/
v1
/
tenant
/
integration-reads
/
read
Read from a connected service
curl --request POST \
--url https://api.costgraph.ai/api/v1/tenant/integration-reads/read \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"connection_id": "<string>",
"operation_id": "<string>",
"params": {},
"path": "<string>",
"query": {}
}
'import requests
url = "https://api.costgraph.ai/api/v1/tenant/integration-reads/read"
payload = {
"connection_id": "<string>",
"operation_id": "<string>",
"params": {},
"path": "<string>",
"query": {}
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
connection_id: '<string>',
operation_id: '<string>',
params: {},
path: '<string>',
query: {}
})
};
fetch('https://api.costgraph.ai/api/v1/tenant/integration-reads/read', 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.costgraph.ai/api/v1/tenant/integration-reads/read",
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([
'connection_id' => '<string>',
'operation_id' => '<string>',
'params' => [
],
'path' => '<string>',
'query' => [
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.costgraph.ai/api/v1/tenant/integration-reads/read"
payload := strings.NewReader("{\n \"connection_id\": \"<string>\",\n \"operation_id\": \"<string>\",\n \"params\": {},\n \"path\": \"<string>\",\n \"query\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
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://api.costgraph.ai/api/v1/tenant/integration-reads/read")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"connection_id\": \"<string>\",\n \"operation_id\": \"<string>\",\n \"params\": {},\n \"path\": \"<string>\",\n \"query\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.costgraph.ai/api/v1/tenant/integration-reads/read")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"connection_id\": \"<string>\",\n \"operation_id\": \"<string>\",\n \"params\": {},\n \"path\": \"<string>\",\n \"query\": {}\n}"
response = http.request(request)
puts response.read_body{
"connection": "<string>",
"operation": "<string>",
"provider": "<string>",
"status": 123,
"truncated": true,
"output": "<unknown>"
}{
"message": "some message",
"status": "error"
}{
"message": "some message",
"status": "error"
}{
"message": "some message",
"status": "error"
}{
"message": "some message",
"status": "error"
}{
"message": "some message",
"status": "error"
}{
"message": "some message",
"status": "error"
}Authorizations
API key for machine-to-machine authentication
Body
application/json
What to read
Was this page helpful?
⌘I
Read from a connected service
curl --request POST \
--url https://api.costgraph.ai/api/v1/tenant/integration-reads/read \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"connection_id": "<string>",
"operation_id": "<string>",
"params": {},
"path": "<string>",
"query": {}
}
'import requests
url = "https://api.costgraph.ai/api/v1/tenant/integration-reads/read"
payload = {
"connection_id": "<string>",
"operation_id": "<string>",
"params": {},
"path": "<string>",
"query": {}
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
connection_id: '<string>',
operation_id: '<string>',
params: {},
path: '<string>',
query: {}
})
};
fetch('https://api.costgraph.ai/api/v1/tenant/integration-reads/read', 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.costgraph.ai/api/v1/tenant/integration-reads/read",
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([
'connection_id' => '<string>',
'operation_id' => '<string>',
'params' => [
],
'path' => '<string>',
'query' => [
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.costgraph.ai/api/v1/tenant/integration-reads/read"
payload := strings.NewReader("{\n \"connection_id\": \"<string>\",\n \"operation_id\": \"<string>\",\n \"params\": {},\n \"path\": \"<string>\",\n \"query\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
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://api.costgraph.ai/api/v1/tenant/integration-reads/read")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"connection_id\": \"<string>\",\n \"operation_id\": \"<string>\",\n \"params\": {},\n \"path\": \"<string>\",\n \"query\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.costgraph.ai/api/v1/tenant/integration-reads/read")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"connection_id\": \"<string>\",\n \"operation_id\": \"<string>\",\n \"params\": {},\n \"path\": \"<string>\",\n \"query\": {}\n}"
response = http.request(request)
puts response.read_body{
"connection": "<string>",
"operation": "<string>",
"provider": "<string>",
"status": 123,
"truncated": true,
"output": "<unknown>"
}{
"message": "some message",
"status": "error"
}{
"message": "some message",
"status": "error"
}{
"message": "some message",
"status": "error"
}{
"message": "some message",
"status": "error"
}{
"message": "some message",
"status": "error"
}{
"message": "some message",
"status": "error"
}