Get Schema

Retrieves a specific schema definition by ID or name

GET /partner/schema-definitions/{schemaIdOrName}

Get Schema

cURL

curl --request GET \
  --url https://api.embedreach.com/partner/schema-definitions/{schemaIdOrName}

import requests

url = "https://api.embedreach.com/partner/schema-definitions/{schemaIdOrName}"

response = requests.get(url)

print(response.text)

const options = {method: 'GET'};

fetch('https://api.embedreach.com/partner/schema-definitions/{schemaIdOrName}', 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/partner/schema-definitions/{schemaIdOrName}",
  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/partner/schema-definitions/{schemaIdOrName}"

	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/partner/schema-definitions/{schemaIdOrName}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.embedreach.com/partner/schema-definitions/{schemaIdOrName}")

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

200

{
  "success": true,
  "message": "<string>",
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "platform_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "plural_name": "<string>",
    "pluralName": "<string>",
    "description": "<string>",
    "version_number": 123,
    "versionNumber": 123,
    "reference_schemas": [
      "<string>"
    ],
    "referenceSchemas": [
      "<string>"
    ],
    "schema": {},
    "external_id_field": "<string>",
    "externalIdField": "<string>",
    "created_at": "<string>",
    "createdAt": "<string>",
    "updated_at": "<string>",
    "updatedAt": "<string>",
    "fieldsToExpose": [
      {
        "name": "<string>",
        "jsonPath": "<string>",
        "exposure": [],
        "description": "<string>"
      }
    ],
    "dataConnectionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "source_query": "<string>",
    "sourceQuery": "<string>",
    "deactivated_at": "<string>",
    "deactivatedAt": "<string>",
    "exposeNameJsonPath": "<string>"
  }
}

{
  "message": "<string>",
  "success": false,
  "errors": [
    "<string>"
  ]
}

Path Parameters

schemaIdOrName · string · required

The ID or name of the schema definition to retrieve

Response

200

application/json

Status 200 response

success · boolean · required

message · string

data · object

Show child attributes