---
title: "Look up a public referral share link"
method: GET
path: "/referrals/join/{code}"
tags: ["referrals"]
---

# Look up a public referral share link

`GET /referrals/join/{code}`

## Request

- Base URL: `https://api.instruxi.dev/api/v1/enforcer`
- URL: `https://api.instruxi.dev/api/v1/enforcer/referrals/join/{code}`
- Auth: none declared

## Path parameters

- `code` string, required

## Response `200`

OK

- InternalDeliveryHttpHandlerReferralPublicJoinResponse
  - `data` EnforcerV3InternalUsecaseReferralPublicJoin
    - `code` string
    - `tenant_id` string: TenantID is present only when Valid. A pointer, not a bare uuid.UUID: that zero-valued to "00000000-0000-0000-0000-000000000000" and shipped it on every invalid-code lookup, so an unauthenticated visitor pasting a typo'd share link got back a syntactically valid tenant id. A client that reads tenant_id before checking valid would carry the nil UUID into a join. omitempty on a [16]byte array does nothing, so the field has to be nilable to be omitted at all.
    - `valid` boolean
  - `success` boolean

## Other responses

- `400`: Bad Request
- `404`: Not Found

---

[API](https://skmtc.dev/instruxi/apis/enforcer-api.md) · [All operations](https://skmtc.dev/instruxi/apis/enforcer-api/llms.txt) · [OpenAPI document](https://skmtc.dev/instruxi/apis/enforcer-api/revisions/fa82bc1becc0?raw)