Step 3a — Get All Primary Customers

GET /api/customer

getAllCustomers

cURL

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

200

{
  "content": [
    {
      "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>"
    }
  ],
  "empty": true,
  "first": true,
  "last": true,
  "number": 123,
  "numberOfElements": 123,
  "pageable": {
    "offset": 123,
    "pageNumber": 123,
    "pageSize": 123,
    "paged": true,
    "sort": {
      "empty": true,
      "sorted": true,
      "unsorted": true
    },
    "unpaged": true
  },
  "size": 123,
  "sort": {
    "empty": true,
    "sorted": true,
    "unsorted": true
  },
  "totalElements": 123,
  "totalPages": 123
}

This endpoint retrieves a list of all primary customers within the current domain.

The response is paginated and may include filtering or search options depending on your backend configuration. Each customer object in the response contains its profile details, status, and identifiers.

Use this endpoint when you need to display or manage all customers at once, for example in an admin dashboard or during batch processing.

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

Query Parameters

activeList · boolean[]

customerStatusList · enum<string>[]

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

customerTypeList · enum<string>[]

Available options: CORPORATE, INDIVIDUAL

size · integer<int64>

page · integer<int64>

offset · integer<int64>

paged · boolean

pageNumber · integer<int32>

pageSize · integer<int32>

referenceId · string

riskRatingList · enum<string>[]

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

searchString · string

searchString

sort.sorted · boolean

sort.unsorted · boolean

unpaged · boolean

Response

200

*/*

OK

content · CustomerResponseDto · object[]

Show child attributes

empty · boolean

first · boolean

last · boolean

number · integer<int32>

numberOfElements · integer<int32>

pageable · Pageable · object

Show child attributes

size · integer<int32>

sort · Sort · object

Show child attributes

totalElements · integer<int64>

totalPages · integer<int32>