Step 3b — Get a Single Primary Customer

GET /api/customer/{customerId}

getCustomerDetails

cURL

curl --request GET \
  --url https://api.artemis.cynopsis.co/api/customer/{customerId} \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Domain-ID: <x-domain-id>'

200

{
  "active": true,
  "assignees": [
    {
      "email": "<string>",
      "firstName": "<string>",
      "fullName": "<string>",
      "id": 123,
      "lastName": "<string>"
    }
  ],
  "createdAt": {
    "date": 123,
    "day": 123,
    "hours": 123,
    "minutes": 123,
    "month": 123,
    "nanos": 123,
    "seconds": 123,
    "time": 123,
    "timezoneOffset": 123,
    "year": 123
  },
  "createdBy": {
    "email": "<string>",
    "firstName": "<string>",
    "fullName": "<string>",
    "id": 123,
    "lastName": "<string>"
  },
  "forms": {},
  "id": 123,
  "lastRiskAssessment": "2023-11-07T05:31:56Z",
  "listRoleAsText": [
    "<string>"
  ],
  "notes": {},
  "other": {},
  "parentId": 123,
  "particular": {},
  "profileId": 123,
  "profileReferenceId": "<string>",
  "referenceId": "<string>",
  "riskRating": "HIGH",
  "roles": [
    {
      "appointedDate": "2023-12-25",
      "createdAt": {
        "date": 123,
        "day": 123,
        "hours": 123,
        "minutes": 123,
        "month": 123,
        "nanos": 123,
        "seconds": 123,
        "time": 123,
        "timezoneOffset": 123,
        "year": 123
      },
      "createdBy": {
        "email": "<string>",
        "firstName": "<string>",
        "fullName": "<string>",
        "id": 123,
        "lastName": "<string>"
      },
      "id": 123,
      "resignedDate": "2023-12-25",
      "role": "<string>",
      "updatedAt": {
        "date": 123,
        "day": 123,
        "hours": 123,
        "minutes": 123,
        "month": 123,
        "nanos": 123,
        "seconds": 123,
        "time": 123,
        "timezoneOffset": 123,
        "year": 123
      },
      "updatedBy": {
        "email": "<string>",
        "firstName": "<string>",
        "fullName": "<string>",
        "id": 123,
        "lastName": "<string>"
      }
    }
  ],
  "status": "ACCEPTED",
  "type": "CORPORATE",
  "updatedAt": {
    "date": 123,
    "day": 123,
    "hours": 123,
    "minutes": 123,
    "month": 123,
    "nanos": 123,
    "seconds": 123,
    "time": 123,
    "timezoneOffset": 123,
    "year": 123
  },
  "updatedBy": {
    "email": "<string>",
    "firstName": "<string>",
    "fullName": "<string>",
    "id": 123,
    "lastName": "<string>"
  },
  "vendorEntityGuid": "<string>",
  "vendorName": "<string>"
}

This endpoint retrieves the full details of a single primary customer.

You can retrieve a customer in two ways:

1. By unique customerId (path parameter)

   • Standard usage:
     GET /api/customer/{customerId}
     

2. By query parameters

   • Instead of customerId, you may search with:
     • caseId

   Example (using customer_reference_id):

   curl -X GET "{{backend_url}}/api/customer?customer_reference_id={{caseId}}" \
     -H "Authorization: Bearer <token>" \
     -H "X-Domain-ID: {{domain_id}}"
   

Authorizations

OAuth2_Client_CredentialsOAuth2_Password

Authorization · string · header · required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

X-Domain-ID · integer<int64> · required

X-Domain-ID

Path Parameters

customerId · integer<int64> · required

customerId

Response

200

*/*

OK

active · boolean

assignees · UserInfo · object[]

Show child attributes

createdAt · Timestamp · object

Show child attributes

createdBy · UserInfo · object

Show child attributes

forms · JsonNode · object

id · integer<int64>

lastRiskAssessment · string<date-time>

listRoleAsText · string[]

notes · JsonNode · object

other · JsonNode · object

parentId · integer<int64>

particular · JsonNode · object

profileId · integer<int64>

profileReferenceId · string

referenceId · string

riskRating · enum<string>

Available options: HIGH, LOW, MEDIUM, MEDIUM_HIGH, MEDIUM_LOW, UNKNOWN

roles · CRPRoleResponseDto · object[]

Show child attributes

status · enum<string>

Available options: ACCEPTED, CLEARED, DRAFT, PENDING, REJECTED, REQUEST_CHANGES

type · enum<string>

Available options: CORPORATE, INDIVIDUAL

updatedAt · Timestamp · object

Show child attributes

updatedBy · UserInfo · object

Show child attributes

vendorEntityGuid · string

vendorName · string