User Objects

Short User

The ShortUser object contains the minimum user data required in a list of users. Any time a list of users is returned, the ShortUser object will describe the items included.

short_user: {
    user_id: Int
    display_name: String
    first_name: String
    email: String
    profile_picture_url: String
}

Key	Type	Description
user_id	Int
display_name	String	A concatenation of the user's first and last name
first_name	String
email	String
profile_picture_url	String	A url string pointing to the Sunday Peak CDN

User

The User object contains all the relevant data about a given user. When a login, signup, or getOtherUser call is made, the User object is returned as part of the response object

user: {
    first_name: String
    last_name: String
    email: String
    bio: String
    city: String
    id: Number
    phone: String
    user_site: String
    profile_picture_url: String
    email_opt_out: Boolean
    friends: Friend[]
    images: String[]
    completed_adventures: CompletedAdventure[]
    todo_adventures: TodoAdventure[]
}

Key	Type	Description
first_name	String
last_name	String
email	String
bio	String
city	String
id	Int
phone	String
user_site	String	A url string depecting any website the user wishes to post in conjunction with their profile
profile_picture_url	String	A url string pointing to the Sunday Peak CDN
email_opt_out	Boolean	Describing whether the user has opted out of marketing emails
friends	ShortUser[]
images	String[]
completed_adventures	ShortAdventure[]
todo_adventures	ShortAdventure[]

Key	Type	Description
user_id	Int	Referencing the id of the friend user
display_name	String	A user's first and last name concatenated into one string
first_name	String	Just the user's first name for when a shorter name field is required
profile_picture_url	String	A url string pointing to the Sunday Peak CDN
email	String
email_opt_out	Boolean	Describing whether the user has opted out of marketing emails