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

# Get referral types

`GET /referraltypes`

## Request

- Base URL: `https://api.smokeball.com`
- URL: `https://api.smokeball.com/referraltypes`
- Auth: API key in header `x-api-key` and API key in header `Authorization`

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.dev/smokeball/apis/smokeball-api.md) - [All operations](https://skmtc.dev/smokeball/apis/smokeball-api/llms.txt) - [OpenAPI document](https://skmtc.dev/smokeball/apis/smokeball-api/revisions/6e350cf667d4?raw)