cURL
curl --request GET \ --url https://api.partner.dit.myperch.io/v1/referralCodes/{id}/plans \ --header 'x-api-key: <api-key>'
{ "meta": { "totalCount": 42 }, "data": [ { "id": "iMVNwkks", "createdAt": "2025-07-22T21:17:14.403Z", "updatedAt": "2025-07-22T21:17:14.434Z", "type": "Buying", "name": "Buying Plan", "status": "New", "inactiveAt": null }, { "id": "29G68f3q", "createdAt": "2025-07-22T21:17:14.635Z", "updatedAt": "2025-07-22T21:17:14.642Z", "type": "Refinancing", "name": "Refinancing Plan", "status": "New", "inactiveAt": null } ] }
Gets a list of records from the Plan table based on passed parameters and implicit access controls.
The id of the record to retrieve.
"abc123"
Successful response
The response is of type object.
object