Get a referral type

Retrieves a specified referral type.

GET /referraltypes/{id}

Get a referral type

cURL

curl --request GET \
  --url https://api.smokeball.com/referraltypes/{id} \
  --header 'Authorization: <api-key>' \
  --header 'x-api-key: <api-key>'

200

{
  "href": "<string>",
  "relation": "<string>",
  "method": "GET",
  "self": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "GET"
  },
  "id": "<string>",
  "name": "<string>",
  "isDeleted": true
}

Authorizations

x-api-key · string · header · required

Authorization · string · header · required

Path Parameters

id · string · required

Response

200

application/json

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

href · string | null

relation · string | null

method · string | null · default: GET

self · object

Show child attributes

id · string | null

Id of the referral type.

name · string | null

Name of the referral type.

isDeleted · boolean

Flag indicating whether the referral type has been deleted.