Referral Types

Get a referral type

Retrieves a specified referral type.

get/referraltypes/{id}

Request

  • Base URL
    https://api.smokeball.com
  • URL
    https://api.smokeball.com/referraltypes/{id}
  • Auth
    API key in header x-api-key and API key in header Authorization

Path parameters

idstring required

Response

When request is successful. Returns a 'ReferralType' object.

hrefstring nullable
relationstring nullable
methodstring nullable
idstring nullable

Id of the referral type.

namestring nullable

Name of the referral type.

isDeletedboolean

Flag indicating whether the referral type has been deleted.

Changes

No recorded changes to this operation across all 15 revisions of this API.