Get Resource
curl --request GET \
--url https://api.embedreach.com/api/resources/{schemaDefinitionNameOrId}/{externalId}import requests
url = "https://api.embedreach.com/api/resources/{schemaDefinitionNameOrId}/{externalId}"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.embedreach.com/api/resources/{schemaDefinitionNameOrId}/{externalId}', 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.embedreach.com/api/resources/{schemaDefinitionNameOrId}/{externalId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$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.embedreach.com/api/resources/{schemaDefinitionNameOrId}/{externalId}"
req, _ := http.NewRequest("GET", url, nil)
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.embedreach.com/api/resources/{schemaDefinitionNameOrId}/{externalId}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.embedreach.com/api/resources/{schemaDefinitionNameOrId}/{externalId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"success": true,
"message": "<string>",
"data": {
"result": {},
"included": [
{
"type": "<string>",
"id": "<string>",
"attributes": {}
}
]
}
}{
"message": "<string>",
"success": false,
"errors": [
"<string>"
]
}{
"success": true,
"message": "<string>",
"data": {
"error": "<string>"
}
}Partner Resources
Get Resource
Retrieves the schema-defined resource data by its external ID. The result contains the raw resource fields rather than resource metadata. Reference fields use the requested referenceFormat. Resources requested through include are returned as objects.
GET
/
api
/
resources
/
{schemaDefinitionNameOrId}
/
{externalId}
Get Resource
curl --request GET \
--url https://api.embedreach.com/api/resources/{schemaDefinitionNameOrId}/{externalId}import requests
url = "https://api.embedreach.com/api/resources/{schemaDefinitionNameOrId}/{externalId}"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.embedreach.com/api/resources/{schemaDefinitionNameOrId}/{externalId}', 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.embedreach.com/api/resources/{schemaDefinitionNameOrId}/{externalId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$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.embedreach.com/api/resources/{schemaDefinitionNameOrId}/{externalId}"
req, _ := http.NewRequest("GET", url, nil)
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.embedreach.com/api/resources/{schemaDefinitionNameOrId}/{externalId}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.embedreach.com/api/resources/{schemaDefinitionNameOrId}/{externalId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"success": true,
"message": "<string>",
"data": {
"result": {},
"included": [
{
"type": "<string>",
"id": "<string>",
"attributes": {}
}
]
}
}{
"message": "<string>",
"success": false,
"errors": [
"<string>"
]
}{
"success": true,
"message": "<string>",
"data": {
"error": "<string>"
}
}Headers
If using a platform scoped JWT, you can pass in a header to impersonate a specific tenant to impersonate the request as.
Path Parameters
The name or id of the schema definition to filter the resources by
The external ID of the resource to retrieve
Query Parameters
Comma-separated list of reference ($ref) fields to include in the response. (Supports nested references with dot notation)
How to return reference fields: object = { type, id } (default), id = plain id or array of ids. "id" is recommended and will become the default in a future version.
Available options:
object, id