Pocketflows home page

Support
Dashboard
Dashboard

Locations

List all locations

Base

Email and SMS

Loyalty

Rewards Programs

The Rewards Program object
GET
List all rewards programs
POST
Create a rewards program
GET
Retrieve a rewards program

Tiers

The Tier object
GET
List all tiers
POST
Create a tier

Members

The Member object
GET
List all members for a rewards program
POST
Create a member
GET
Retrieve a member

Locations

The Location object
GET
List all locations
GET
List the locations under a rewards program
POST
Create a location
GET
Retrieve a location
POST
Update a location

Location Members

The Location Member object
GET
List all location members
POST
Create a new location member
GET
Retrieve a location member

Track

POST
Track when a user books a class
POST
Track when a user purchases an item
POST
Track when a user redeems their points

Flows

Introduction
The Flow object
POST
Create a flow
GET
Embed a flow

Locations

List all locations

GET

locations

Authorizations

Authorization

string

header

required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Response

200 - application/json

A dictionary with a `locations` property which is an array of `Location` objects

locations

object[]

required

An array of Location objects

locations.id

string

required

The ID of the location

locations.rewards_program

required

The location's rewards program

locations.rewards_program.id

string

required

The ID of the rewards program

locations.rewards_program.points_earned_per_dollar_spent

integer

required

The number of points earned per dollar spent

locations.rewards_program.point_redemption_value

string

required

The value of a single point in dollars

locations.rewards_program.points_for_member_class_attendance

integer

required

The number of points earned for attending a class

locations.rewards_program.points_for_referring_new_student

integer

required

The number of points earned for referring a new student

locations.rewards_program.points_for_referring_new_student_that_signs_up

integer

required

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

locations.rewards_program.points_for_every_ten_classes_non_member

integer

required

The number of points earned for every ten classes attended

locations.rewards_program.points_for_first_visit_in_three_months

integer

required

The number of points earned for first visit in three months

The Location object List the locations under a rewards program