Skip to main content
GET
Read the workspace's referral link

Authorizations

Authorization
string
header
required

WorkOS access JWT or a user-owned WorkOS API key. User keys are bound to one organization and restricted to their enabled product permissions. Session-only onboarding and session revocation require an interactive access JWT. No cookie session is assumed.

Headers

X-Request-Id
string

Optional caller-provided correlation identifier.

Required string length: 1 - 128

Path Parameters

organization_id
string
required
Pattern: ^[0-9A-HJKMNP-TV-Z]{26}$

Response

The workspace's referral link.

organization_id
string
required
Pattern: ^[0-9A-HJKMNP-TV-Z]{26}$
referral_url
string<uri>
required
Pattern: ^https://ohmyho\.st/\?r=ref-[0-7][0-9a-hjkmnp-tv-z]{25}$