Skip to main content
GET
/
api
/
customer
/
{customerId}
/
crp
getCRP
curl --request GET \
  --url https://api.artemis.cynopsis.co/api/customer/{customerId}/crp \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Domain-ID: <x-domain-id>'
{
  "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 all Customer Related Parties (CRPs) that belong to a given Primary Customer, identified by customerId. Use this endpoint to view the associated parties (individual or corporate) of a primary customer, along with their roles, particulars, and relationship details.

Authorizations

​
Authorization
string
header
required

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

Headers

​
X-Domain-ID
integer
required

X-Domain-ID

Path Parameters

​
customerId
integer
required

customerId

Query Parameters

​
offset
integer
​
paged
boolean
​
pageNumber
integer
​
pageSize
integer
​
profileReferenceId
string

profileReferenceId

​
searchString
string

searchString

​
sort.sorted
boolean
​
sort.unsorted
boolean
​
unpaged
boolean

Response

OK

​
content
CustomerResponseDto · object[]
​
empty
boolean
​
first
boolean
​
last
boolean
​
number
integer
​
numberOfElements
integer
​
pageable
object
​
size
integer
​
sort
object
​
totalElements
integer
​
totalPages
integer