Sign in
latestOpenAPI 3.1.0Apache License Version 2.02026-08-17498525913.3 KB

40169ccdec5c

customer-controller

Get Customer (getCustomerById)

Get the Customer object based on the provided Customer Id. If the user has the authority of 'Tenant Administrator', the server checks that the customer is owned by the same tenant. If the user has the authority of 'Customer User', the server checks that the user belongs to the customer.

Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority.

get/api/customer/{customerId}

Path parameters

customerIdstring required

A string value representing the customer id. For example, '784f394c-42b6-435a-983c-b7beff2784f9'

Response

OK

createdTimeinteger

Timestamp of the customer creation, in milliseconds

countrystring

Country

statestring

State

citystring

City

addressstring

Address Line 1

address2string

Address Line 2

zipstring

Zip code

phonestring

Phone number

emailstring required

Email

titlestring required

Title of the customer

versioninteger
namestring

Name of the customer. Read-only, duplicated from title for backward compatibility

{"stackTrail":"components:schemas:JsonNode","oasType":"schema","type":"unknown","description":"A value representing the any type (object or primitive)","example":{}}

Example response

{
  "id": {
    "id": "784f394c-42b6-435a-983c-b7beff2784f9",
    "entityType": "CUSTOMER"
  },
  "createdTime": 1609459200000,
  "country": "US",
  "state": "NY",
  "city": "New York",
  "phone": "+1(415)777-7777",
  "email": "example@company.com",
  "title": "Company A",
  "tenantId": {
    "id": "784f394c-42b6-435a-983c-b7beff2784f9",
    "entityType": "TENANT"
  },
  "name": "Company A",
  "additionalInfo": {}
}