---
title: "Get referral types"
method: GET
path: "/referraltypes"
tags: ["Referral Types"]
---

# Get referral types

`GET /referraltypes`

Returns referral types, including custom referral types.

## Response `200`

When request is successful. Returns a collection of 'ReferralType' objects.

- ReferralTypeCollection
  - `id` string, nullable
  - `href` string, nullable
  - `relation` string, nullable
  - `method` string, nullable
  - `self` Link
    - `id` string, nullable
    - `href` string, nullable
    - `relation` string, nullable
    - `method` string, nullable
  - `value` ReferralType[], nullable
    - `href` string, nullable
    - `relation` string, nullable
    - `method` string, nullable
    - `self` Link
      - `id` string, nullable
      - `href` string, nullable
      - `relation` string, nullable
      - `method` string, nullable
    - `id` string, nullable — Id of the referral type.
    - `name` string, nullable — Name of the referral type.
    - `isDeleted` boolean — Flag indicating whether the referral type has been deleted.

---

[API](https://skmtc.net/smokeball/apis/api.md) · [All operations](https://skmtc.net/smokeball/apis/api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/smokeball/api/revisions/197984da9b42/schema)