Skip to main content
Creating an Appraisal record requires a Reference (or ‘cart’) id. A Reference (or cart) can contain 1 or more Appraisals.
You should have a client_reference_id from Step 1. Create Reference (or Step1.1) to use in the request path.
If an identical Appraisal record exists in the same client_reference (the same cpid and rpid), we will create a new appraisal record with a different identifier (appraisal_id).
Create Appraisal Endpoint➜

​
View All Appraisals

To view all/any Appraisals within a reference, call the same endpoint without any parameters.
You should have a client_reference_id from Step 1. Create Reference (or Step1.1) to use in the request path.
Depending how the appraisal was created, the response may contain additional values.
All Appraisals In Specific Client Reference Endpoint➜

​
Delete All Appraisals

To remove all Appraisals from a reference, call the same endpoint without any parameters.
This empties the Reference of all Appraisals but does not delete the actual Reference itself.
Delete All Appraisals In Specific Client Reference Endpoint➜

​
View An Appraisal

The appraisal_id (returned from Create Appraisal) is required in addition to the client_reference_id.
Get Specific Appraisal➜

​
Modify An Appraisal

Modifications are passed as parameters in the payload (formatted in JSON).
Modify Specific Appraisal➜

​
Delete An Appraisal

To remove a specific Appraisal from a reference, pass the appraisal_id in the path.
Delete Specific Appraisal➜

​
Get All Client References With Appraisals

For bulk operations and reporting, you can export all client references with their appraisals for all users within your client.
Export Client References With Appraisals Endpoint➜