curl --request GET \
--url https://api.embedreach.com/partner/schema-definitions/{schemaIdOrName}
{
"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>",
"category": "contacts_schema",
"version_number": 123,
"versionNumber": 123,
"partner_db_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"partnerDbId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"partner_db_query": "<string>",
"partnerDbQuery": "<string>",
"reference_schemas": [
"<string>"
],
"referenceSchemas": [
"<string>"
],
"schema": {},
"external_id_field": "<string>",
"externalIdField": "<string>",
"deactivated_at": "<string>",
"deactivatedAt": "<string>",
"created_at": "<string>",
"createdAt": "<string>",
"updated_at": "<string>",
"updatedAt": "<string>"
}
}
Retrieves a specific schema definition by ID or name
curl --request GET \
--url https://api.embedreach.com/partner/schema-definitions/{schemaIdOrName}
{
"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>",
"category": "contacts_schema",
"version_number": 123,
"versionNumber": 123,
"partner_db_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"partnerDbId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"partner_db_query": "<string>",
"partnerDbQuery": "<string>",
"reference_schemas": [
"<string>"
],
"referenceSchemas": [
"<string>"
],
"schema": {},
"external_id_field": "<string>",
"externalIdField": "<string>",
"deactivated_at": "<string>",
"deactivatedAt": "<string>",
"created_at": "<string>",
"createdAt": "<string>",
"updated_at": "<string>",
"updatedAt": "<string>"
}
}
The ID or name of the schema definition to retrieve
Status 200 response
The response is of type object
.