Get Customer Resource - Reach Marketing & Automation Documentation

Get Customer Resource

curl --request GET \
  --url https://api.embedreach.com/api/resources/customers/{externalId}

{
  "success": true,
  "message": "<string>",
  "data": {
    "result": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "schema_definition_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "schemaDefinitionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "platform_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "platformId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "business_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "businessId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "resource_external_id": "<string>",
      "resourceExternalId": "<string>",
      "created_at": "<string>",
      "createdAt": "<string>",
      "updated_at": "<string>",
      "updatedAt": "<string>",
      "data": {
        "customerId": "<string>",
        "firstName": "<string>",
        "lastName": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "email": "<string>",
        "phone": "<string>",
        "emailOptOut": true,
        "smsOptOut": true,
        "customerDetailUrl": "<string>"
      }
    },
    "included": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "schema_definition_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "schemaDefinitionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "platform_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "platformId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "business_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "businessId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "resource_external_id": "<string>",
        "resourceExternalId": "<string>",
        "created_at": "<string>",
        "createdAt": "<string>",
        "updated_at": "<string>",
        "updatedAt": "<string>",
        "data": {
          "customerId": "<string>",
          "firstName": "<string>",
          "lastName": "<string>",
          "createdAt": "2023-11-07T05:31:56Z",
          "email": "<string>",
          "phone": "<string>",
          "emailOptOut": true,
          "smsOptOut": true,
          "customerDetailUrl": "<string>"
        }
      }
    ]
  }
}

GET

api

resources

customers

{externalId}

Get Customer Resource

curl --request GET \
  --url https://api.embedreach.com/api/resources/customers/{externalId}

{
  "success": true,
  "message": "<string>",
  "data": {
    "result": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "schema_definition_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "schemaDefinitionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "platform_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "platformId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "business_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "businessId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "resource_external_id": "<string>",
      "resourceExternalId": "<string>",
      "created_at": "<string>",
      "createdAt": "<string>",
      "updated_at": "<string>",
      "updatedAt": "<string>",
      "data": {
        "customerId": "<string>",
        "firstName": "<string>",
        "lastName": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "email": "<string>",
        "phone": "<string>",
        "emailOptOut": true,
        "smsOptOut": true,
        "customerDetailUrl": "<string>"
      }
    },
    "included": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "schema_definition_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "schemaDefinitionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "platform_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "platformId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "business_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "businessId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "resource_external_id": "<string>",
        "resourceExternalId": "<string>",
        "created_at": "<string>",
        "createdAt": "<string>",
        "updated_at": "<string>",
        "updatedAt": "<string>",
        "data": {
          "customerId": "<string>",
          "firstName": "<string>",
          "lastName": "<string>",
          "createdAt": "2023-11-07T05:31:56Z",
          "email": "<string>",
          "phone": "<string>",
          "emailOptOut": true,
          "smsOptOut": true,
          "customerDetailUrl": "<string>"
        }
      }
    ]
  }
}

Headers

reach-tenant-id

string

If using a platform scoped JWT, you can pass in a header to impersonate a specific tenant to impersonate the request as.

Path Parameters

externalId

string

required

The external ID of the customer resource to retrieve

Query Parameters

include

string

Comma-separated list of reference ($ref) fields to include in the response. (Supports nested references with dot notation)

Response

Status 200 response

success

boolean

required

message

string

data

object

Show child attributes

data.result

object

required

Show child attributes

data.result.id

string<uuid>

required

Unique identifier for the resource

data.result.schema_definition_id

string<uuid>

required

[Deprecated] Please use schemaDefinitionId instead. ID of the schema definition for this resource

data.result.schemaDefinitionId

string<uuid>

required

ID of the schema definition for this resource

data.result.platform_id

string<uuid>

required

[Deprecated] Please use platformId instead. ID of the platform this resource belongs to

data.result.platformId

string<uuid>

required

ID of the platform this resource belongs to

data.result.business_id

string<uuid>

required

[Deprecated] Please use businessId instead. ID of the business this resource belongs to

data.result.businessId

string<uuid>

required

ID of the business this resource belongs to

data.result.resource_external_id

string

required

External ID of the resource

data.result.resourceExternalId

string

required

[Deprecated] Please use resourceExternalId instead. External ID of the resource

data.result.created_at

string

required

[Deprecated] Please use createdAt instead

data.result.createdAt

string

required

Creation timestamp

data.result.updated_at

string

required

[Deprecated] Please use updatedAt instead

data.result.updatedAt

string

required

Last update timestamp

data.result.data

object

required

Show child attributes

data.result.data.customerId

string

required

data.result.data.firstName

string

required

data.result.data.lastName

string

required

data.result.data.createdAt

string<date-time>

required

data.result.data.email

string

data.result.data.phone

string

data.result.data.emailOptOut

boolean

Email subscription opt-out status. Defaults to false (opted in)

data.result.data.smsOptOut

boolean

SMS subscription opt-out status. Defaults to true (opted out)

data.result.data.customerDetailUrl

string

URL to click-out to the customer detail page

data.included

object[]

Included resources when specified in the include parameter

Show child attributes

data.included.id

string<uuid>

required

Unique identifier for the resource

data.included.schema_definition_id

string<uuid>

required

[Deprecated] Please use schemaDefinitionId instead. ID of the schema definition for this resource

data.included.schemaDefinitionId

string<uuid>

required

ID of the schema definition for this resource

data.included.platform_id

string<uuid>

required

[Deprecated] Please use platformId instead. ID of the platform this resource belongs to

data.included.platformId

string<uuid>

required

ID of the platform this resource belongs to

data.included.business_id

string<uuid>

required

[Deprecated] Please use businessId instead. ID of the business this resource belongs to

data.included.businessId

string<uuid>

required

ID of the business this resource belongs to

data.included.resource_external_id

string

required

External ID of the resource

data.included.resourceExternalId

string

required

[Deprecated] Please use resourceExternalId instead. External ID of the resource

data.included.created_at

string

required

[Deprecated] Please use createdAt instead

data.included.createdAt

string

required

Creation timestamp

data.included.updated_at

string

required

[Deprecated] Please use updatedAt instead

data.included.updatedAt

string

required

Last update timestamp

data.included.data

object

required

Show child attributes

data.included.data.customerId

string

required

data.included.data.firstName

string

required

data.included.data.lastName

string

required

data.included.data.createdAt

string<date-time>

required

data.included.data.email

string

data.included.data.phone

string

data.included.data.emailOptOut

boolean

Email subscription opt-out status. Defaults to false (opted in)

data.included.data.smsOptOut

boolean

SMS subscription opt-out status. Defaults to true (opted out)

data.included.data.customerDetailUrl

string

URL to click-out to the customer detail page

List Customer Resources List Location Resources

⌘I

API Documentation

Headers

Path Parameters

Query Parameters

Response