Get a customer by ticket id

GET

customer

byTicketId

{ticketId}

curl --request GET \
  --url https://demo.enneo.ai/api/mind/customer/byTicketId/{ticketId}

{
  "id": 83771,
  "emailMatches": true,
  "business": false,
  "company": null,
  "firstname": "Tom",
  "lastname": "Mustermann",
  "address": "Hugo-Junkers-Str. 5",
  "phone": 49123456789,
  "email": "tom@mustermann.de",
  "tags": [
    {
      "id": 2,
      "color": "green",
      "name": "VIP"
    }
  ],
  "contracts": [
    {
      "id": 746839,
      "orderId": 123,
      "tenant": null,
      "customerId": 123,
      "signupDate": 1661126400,
      "status": "active",
      "statusCode": 5000,
      "statusCodeTitle": "active",
      "energy": "electricity",
      "energyTypeId": 1,
      "energySubTypeId": 1,
      "email": "johndoe@example.com",
      "firstname": "John",
      "lastname": "Doe",
      "deliveryAddress": "Hugo-Junkers-Str. 5, 82031 Grünwald",
      "iban": "DE89370400440532013000",
      "monthlyDeposit": 53,
      "startDate": 1661990400,
      "endDate": null,
      "consumption": 3477,
      "counterNumber": "1ESY1160669167",
      "productId": 1,
      "productName": "Flex 24",
      "productCode": "flx_24",
      "campaignId": 1,
      "salesChannelId": 1,
      "unpaidDebt": 109.21,
      "vatRate": 0.09,
      "basePrice": 0.09,
      "workingPrice": 0.09,
      "billingAddress": "Rechnungssstraße 24, 10587 Berlin",
      "business": false,
      "phone": 491721041689,
      "gridOperatorName": "E.ON Bayern AG",
      "gridOperatorCode": 1000000000000,
      "registers": [
        {}
      ],
      "erpUrls": [
        {
          "url": "https://erp-system.com/contract/123",
          "logo": "powercloud"
        }
      ],
      "rawData": null,
      "agentPreview": [
        {
          "label": "Tarif",
          "value": "Flex 24",
          "tooltip": "AP: 28.5 ct/kWh\nGP: 149.88 €/Jahr",
          "url": "https://erp.example.com/contract/123"
        }
      ],
      "tabPreview": {
        "color": "green",
        "icon": "electricity"
      }
    }
  ],
  "additionalData": {}
}

Authorizations

connect.sid

string

required

Cookie-based authentication

Path Parameters

ticketId

integer

required

The id of the ticket for which the associated customer is requested

Response

200

application/json

Successful operation

integer

Example:

83771

emailMatches

boolean | null

If false, the customer sent the email from an account that doesn't match our records. Always returns 'null' when customer is retrieved by customerId and not by ticketId

Example:

true

business

boolean

Example:

false

company

string | null

Name of the company. Null when customer is not a business but private

Example:

null

firstname

string

Example:

"Tom"

lastname

string

Example:

"Mustermann"

address

string

Example:

"Hugo-Junkers-Str. 5"

phone

string

Example:

49123456789

string

Example:

"tom@mustermann.de"

tags

object[]

contracts

object[]

Contracts that this customer has

A contract of a customer. Either electricity or gas. IDs match the backend system (powercloud)

contracts.id

integer

Example:

746839

contracts.orderId

integer

Example:

123

contracts.tenant

string | null

If a customer has multiple tenants/brands, this is the tenant name. Currently only used for SAP

Example:

null

contracts.customerId

integer

Example:

123

Example:

1661126400

contracts.status

string

Example:

"active"

contracts.statusCode

integer

Example:

5000

contracts.statusCodeTitle

string

Example:

"active"

contracts.energy

string

Example:

"electricity"

contracts.energyTypeId

integer

Example:

1

contracts.energySubTypeId

integer

Example:

1

contracts.email

string

Example:

"johndoe@example.com"

contracts.firstname

string

Example:

"John"

contracts.lastname

string

Example:

"Doe"

contracts.deliveryAddress

string

Address where the electricity/gas is being delivered to

Example:

"Hugo-Junkers-Str. 5, 82031 Grünwald"

contracts.iban

string | null

Example:

"DE89370400440532013000"

contracts.monthlyDeposit

number | null

Example:

53

contracts.startDate

string | null

Example:

1661990400

contracts.endDate

string | null

Example:

null

contracts.consumption

integer | null

Example:

3477

contracts.counterNumber

string | null

Example:

"1ESY1160669167"

contracts.productId

integer | null

Example:

1

contracts.productName

string | null

Example:

"Flex 24"

contracts.productCode

string | null

Example:

"flx_24"

contracts.campaignId

integer | null

Example:

1

contracts.salesChannelId

integer | null

Example:

1

contracts.unpaidDebt

number | null

Example:

109.21

contracts.vatRate

number | null

VAT Rate, usually 0.19 (=19%) for electricity and 0.07 (=7%) for gas

Example:

0.09

contracts.basePrice

number | null

Example:

0.09

contracts.workingPrice

number | null

Example:

0.09

contracts.billingAddress

string | null

Address where written communication should be sent to. NULL if same as delivery address

Example:

"Rechnungssstraße 24, 10587 Berlin"

contracts.business

boolean | null

Example:

false

contracts.phone

string | null

Example:

491721041689

contracts.gridOperatorName

string | null

Example:

"E.ON Bayern AG"

contracts.gridOperatorCode

string | null

Example:

1000000000000

contracts.registers

object[] | null

contracts.erpUrls

object[] | null

contracts.rawData

object | null

Raw source data from the originating ERP system in the ERP-proprietary format is included here. Only provided on request.

Example:

null

contracts.agentPreview

object[]

Preview information shown to agents in the UI

contracts.tabPreview

object | null

Preview information shown in contract tabs

additionalData

object

Client-specific data objects can be included here

The response is of type null.

Zurück

Get a customer by customer idGet a customer and associated contracts

Weiter

curl --request GET \
  --url https://demo.enneo.ai/api/mind/customer/byTicketId/{ticketId}

{
  "id": 83771,
  "emailMatches": true,
  "business": false,
  "company": null,
  "firstname": "Tom",
  "lastname": "Mustermann",
  "address": "Hugo-Junkers-Str. 5",
  "phone": 49123456789,
  "email": "tom@mustermann.de",
  "tags": [
    {
      "id": 2,
      "color": "green",
      "name": "VIP"
    }
  ],
  "contracts": [
    {
      "id": 746839,
      "orderId": 123,
      "tenant": null,
      "customerId": 123,
      "signupDate": 1661126400,
      "status": "active",
      "statusCode": 5000,
      "statusCodeTitle": "active",
      "energy": "electricity",
      "energyTypeId": 1,
      "energySubTypeId": 1,
      "email": "johndoe@example.com",
      "firstname": "John",
      "lastname": "Doe",
      "deliveryAddress": "Hugo-Junkers-Str. 5, 82031 Grünwald",
      "iban": "DE89370400440532013000",
      "monthlyDeposit": 53,
      "startDate": 1661990400,
      "endDate": null,
      "consumption": 3477,
      "counterNumber": "1ESY1160669167",
      "productId": 1,
      "productName": "Flex 24",
      "productCode": "flx_24",
      "campaignId": 1,
      "salesChannelId": 1,
      "unpaidDebt": 109.21,
      "vatRate": 0.09,
      "basePrice": 0.09,
      "workingPrice": 0.09,
      "billingAddress": "Rechnungssstraße 24, 10587 Berlin",
      "business": false,
      "phone": 491721041689,
      "gridOperatorName": "E.ON Bayern AG",
      "gridOperatorCode": 1000000000000,
      "registers": [
        {}
      ],
      "erpUrls": [
        {
          "url": "https://erp-system.com/contract/123",
          "logo": "powercloud"
        }
      ],
      "rawData": null,
      "agentPreview": [
        {
          "label": "Tarif",
          "value": "Flex 24",
          "tooltip": "AP: 28.5 ct/kWh\nGP: 149.88 €/Jahr",
          "url": "https://erp.example.com/contract/123"
        }
      ],
      "tabPreview": {
        "color": "green",
        "icon": "electricity"
      }
    }
  ],
  "additionalData": {}
}

ticket

export

customer

intent

aiAgent

aiQualityCheck

intentTemplate

profile

team

reminder

settings

tag

role

contract

survey

health

cron

docs

version

knowledgeSourceStructure

knowledgeSource

partner

webhook

report

deferrer

storage

cache

executor

telephony

cortex

tools

Authorizations

Path Parameters

Response