List Schemas - Reach Marketing & Automation Documentation

List Schemas

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

{
  "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,
      "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": [
            "segments"
          ],
          "description": "<string>"
        }
      ],
      "partner_db_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "partnerDbId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "partner_db_query": "<string>",
      "partnerDbQuery": "<string>",
      "deactivated_at": "<string>",
      "deactivatedAt": "<string>",
      "exposeNameJsonPath": "<string>"
    }
  ]
}

GET

partner

schema-definitions

List Schemas

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

{
  "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,
      "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": [
            "segments"
          ],
          "description": "<string>"
        }
      ],
      "partner_db_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "partnerDbId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "partner_db_query": "<string>",
      "partnerDbQuery": "<string>",
      "deactivated_at": "<string>",
      "deactivatedAt": "<string>",
      "exposeNameJsonPath": "<string>"
    }
  ]
}

Response

Status 200 response

success

boolean

required

message

string

data

object[]

List of schema definitions

Show child attributes

data.id

string<uuid>

required

Unique identifier for the schema definition

data.platform_id

string<uuid>

required

Platform ID this schema belongs to

data.name

string

required

Name of the schema

data.plural_name

string

required

[Deprecated] Please use pluralName instead. Plural name of the schema

data.pluralName

string

required

Plural name of the schema

data.description

string | null

required

Description of the schema

data.category

enum<string>

required

Schema category

Available options:

contacts_schema,

transactions_schema,

custom_schema,

combined_schema,

locations_schema,

customer_fields

data.version_number

number

required

[Deprecated] Please use versionNumber instead. Schema version number

data.versionNumber

number

required

Schema version number

data.reference_schemas

string[] | null

required

[Deprecated] Please use referenceSchemas instead. References to other schemas

data.referenceSchemas

string[] | null

required

References to other schemas

data.schema

object

required

The actual JSON schema definition

Show child attributes

data.schema.{key}

unknown

data.external_id_field

string

required

[Deprecated] Please use externalIdField instead. Field used for external ID references

data.externalIdField

string

required

Field used for external ID references

data.created_at

string

required

[Deprecated] Please use createdAt instead. Creation timestamp

data.createdAt

string

required

Creation timestamp

data.updated_at

string

required

[Deprecated] Please use updatedAt instead. Last update timestamp

data.updatedAt

string

required

Last update timestamp

data.fieldsToExpose

object[]

required

Fields to expose

Show child attributes

data.fieldsToExpose.name

string

required

The name of the field

data.fieldsToExpose.jsonPath

string

required

The JSON path to the field in the custom resource (e.g. .user.rewards.points for the json { "user": { "rewards": { "points": 100 } } })

data.fieldsToExpose.exposure

enum<string>[]

required

How to expose this field, is it available in segments, email builder, etc.

Available options:

segments,

merge-fields

data.fieldsToExpose.description

string

The description of the field

data.partner_db_id

string<uuid>

[Deprecated] Please use partnerDbId instead. Database ID for the schema

data.partnerDbId

string<uuid>

Database ID for the schema

data.partner_db_query

string

[Deprecated] Please use partnerDbQuery instead. Database query for the schema

data.partnerDbQuery

string

Database query for the schema

data.deactivated_at

string | null

[Deprecated] Please use deactivatedAt instead. When this schema was deactivated

data.deactivatedAt

string | null

When this schema was deactivated

data.exposeNameJsonPath

string

The JSON path to the field in the schema that will be used to expose the resource to the user. If not provided, the resource will not be exposed to the user.

Batch Upload Resources Get Schema

⌘I

API Documentation

Response