Sign in
Rewards programs

Retrieve a rewards program

get/rewards_programs/{id}

Path parameters

idstring required

The ID of the rewards program

Response

A RewardsProgram object

idstring required

The ID of the rewards program

namestring nullable required

The name of the rewards program

points_earned_per_dollar_spentinteger required

The number of points earned per dollar spent

points_for_member_class_attendanceinteger required

The number of points earned for attending a class

points_for_referring_new_studentinteger required

The number of points earned for referring a new student

points_for_referring_new_student_that_signs_upinteger required

The number of points earned for referring a new student that signs up

points_for_every_ten_classes_non_memberinteger required

The number of points earned for every ten classes attended

points_for_first_visit_in_three_monthsinteger required

The number of points earned for first visit in three months

program_image_urlstring nullable required

The URL of the program image

earning_cyclestring nullable required

The earning cycle of the program

publishedboolean required

Whether the program is published

status'draft' | 'backfilling' | 'published' required

The status of the program

Changes

No recorded changes to this endpoint across all 1 revision of this API.