Resolve an active invitation without disclosing account identifiers.
GET /api/v1/referrals/{username}. Resolve an active invitation without disclosing account identifiers.
Request
GET /api/v1/referrals/{username}
The schema permits anonymous access.
Parameters
| Name | In | Type | Required | Constraints | Description |
|---|---|---|---|---|---|
username | path | string | Yes | pattern: ^[a-z][a-z0-9_]{2,23}$ | — |
X-Request-Id | header | string | No | min length: 8; max length: 128; pattern: ^[A-Za-z0-9._:-]+$ | Optional client correlation identifier. The server always generates a separate authoritative request ID and retains a valid supplied value only as secondary audit correlation metadata. |
cURL
Set USERNAME to the path and required query values before running this example. URL-encode path values as needed.
curl --fail-with-body --silent --show-error \
--request GET \
--url "https://launch-api.supanova.app/api/v1/referrals/${USERNAME}"Responses
200
Canonical referral invitation.
| Header | Type | Description |
|---|---|---|
X-Request-Id | string | Server-generated request correlation identifier to retain for support and reconciliation. |
Content type: application/json
Type: object.
| Field | Type | Required | Constraints | Description |
|---|---|---|---|---|
schemaVersion | "1" | Yes | — | — |
networkId | string | Yes | min length: 1 | — |
status | "active" | Yes | — | — |
username | string | Yes | pattern: ^[a-z][a-z0-9_]{2,23}$ | — |
sharePath | string | Yes | — | — |
referralRateBps | 1000 | Yes | — | — |
Additional fields are not allowed.
404
No resource the caller may see matches the path.
| Header | Type | Description |
|---|---|---|
X-Request-Id | string | Server-generated request correlation identifier to retain for support and reconciliation. |
Content type: application/json
Standard envelope: error.code, error.message, optional error.details, and requestId. See error handling and the full code registry.
429
The caller exceeded an IP or principal request budget.
| Header | Type | Description |
|---|---|---|
Retry-After | integer | Whole seconds to wait before retrying a rate-limited request. |
X-Request-Id | string | Server-generated request correlation identifier to retain for support and reconciliation. |
Content type: application/json
Standard envelope: error.code, error.message, optional error.details, and requestId. See error handling and the full code registry.
default
Machine-readable API error. The HTTP status identifies the error class.
| Header | Type | Description |
|---|---|---|
X-Request-Id | string | Server-generated request correlation identifier to retain for support and reconciliation. |
Content type: application/json
Standard envelope: error.code, error.message, optional error.details, and requestId. See error handling and the full code registry.
Source contract
This page is generated from the checked-in customer OpenAPI snapshot. Download JSON, download YAML, or compare the live API reference. Snapshot provenance records the retrieval date and checksum.