ΛΟΓΙΟΝ

Generated from the OpenAPI contract sha256:223ebdfc2cc1ca82…. How this works.

Referrals

4 operations on the Logion v1 API.

List referral attributions

GET /v1/referrals/attributions

Operation id: list_referral_attributions

Takes an Authorization header.

Responses

Status Meaning Schema
200 Successful response —
401 Unauthorized ErrorResponse
422 Validation Error HTTPValidationError

Returns ListReferralAttributionsResponse[].

Get referral code

GET /v1/referrals/code

Operation id: get_referral_code

Takes an Authorization header.

Responses

Status Meaning Schema
200 Successful response GetReferralCodeResponse
401 Unauthorized ErrorResponse
422 Validation Error HTTPValidationError

Returns GetReferralCodeResponse:

Field Type Required Notes
code string yes
is_default boolean yes
label string, optional no
status string yes 
GET /v1/referrals/link

Operation id: get_referral_link

Takes an Authorization header.

Parameters

Name In Type Required
course_id query string(uuid), optional no

Responses

Status Meaning Schema
200 Successful response GetReferralLinkResponse
401 Unauthorized ErrorResponse
422 Validation Error HTTPValidationError

Returns GetReferralLinkResponse:

Field Type Required Notes
course_id string(uuid), optional no
link string yes
referral_code string yes

Get referral statistics

GET /v1/referrals/stats

Operation id: get_referral_stats

Takes an Authorization header.

Responses

Status Meaning Schema
200 Successful response GetReferralStatsResponse
401 Unauthorized ErrorResponse
422 Validation Error HTTPValidationError

Returns GetReferralStatsResponse:

Field Type Required Notes
active_attributions integer yes
pending_rewards_cents integer yes
total_attributions integer yes
total_rewards_credited_cents integer yes