AKakahu
Referrals

List referrals

List the referrals that have been created from an application.

get/v1/applications/{applicationId}/referrals

Request

  • Base URL
    https://api.apply.akahu.nz
  • URL
    https://api.apply.akahu.nz/v1/applications/{applicationId}/referrals
  • Auth
    HTTP bearer

Path parameters

applicationIdstring required
Example:application_tz4a98xxat96iws9zmbrgj3a

Response

Success

Example response

{
  "items": [
    {
      "_id": "referral_tz4a98xxat96iws9zmbrgj3a",
      "code": "AK_23456789BC"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.