GET
/
referralCodes
/
{id}
/
plans
List Plans for ReferralCode
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
    }
  ]
}

Authorizations

x-api-key
string
header
required

Path Parameters

id
string
required

The id of the record to retrieve.

Example:

"abc123"

Response

200 - application/json

Successful response

The response is of type object.