Skip to main content
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": "6eco5FVp",
      "createdAt": "2026-01-13T21:34:53.771Z",
      "updatedAt": "2026-01-13T21:34:53.786Z",
      "type": "Buying",
      "name": "Buying Plan",
      "status": "New",
      "inactiveAt": null
    },
    {
      "id": "od1ukJgp",
      "createdAt": "2026-01-13T21:34:53.950Z",
      "updatedAt": "2026-01-13T21:34:53.956Z",
      "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

​
meta
object
​
data
object[]
Example:
[
  {
    "id": "6eco5FVp",
    "createdAt": "2026-01-13T21:34:53.771Z",
    "updatedAt": "2026-01-13T21:34:53.786Z",
    "type": "Buying",
    "name": "Buying Plan",
    "status": "New",
    "inactiveAt": null
  },
  {
    "id": "od1ukJgp",
    "createdAt": "2026-01-13T21:34:53.950Z",
    "updatedAt": "2026-01-13T21:34:53.956Z",
    "type": "Refinancing",
    "name": "Refinancing Plan",
    "status": "New",
    "inactiveAt": null
  }
]