This API allows you to interact with the High/Low system and database.
\nThe endpoints are organized by services; as the infrastructure was orginally based on a microservices architecture. \nSo if you want to make a query to read, create, update, or edit a High/Low, your endpoint would start with /highlow/.
To make requests to authenticated endpoints, your request must contain the Authorization HTTP header with a value of Bearer <token>. The token must be obtained from one of the appropriate /auth endpoints.
All authenticated endpoints may return an error of value ERROR-INVALID-TOKEN or ERROR-INVALID-REFRESH-TOKEN. \nThe error is usually returned as the key error in a JSON object.
First name of the new user
\n","type":"text"},{"key":"lastname","value":"Doe","description":"Last name of the new user
\n","type":"text"},{"key":"email","value":"johndoe@example.com","description":"Email of the new user
\n","type":"text"},{"key":"password","value":"Password of the new user
\n","type":"text"},{"key":"confirmpassword","value":"Password confirmation (should be equal to password)
\n","type":"text"}]},"url":"https://api.gethighlow.com/auth/sign_up","description":"Used to create a new High/Low account.
\n{\n access: String,\n refresh: String,\n uid: String,\n error: String*\n}\nempty-first-name: The firstname had a length of 0 or nonexistentempty-last-name: The lastname had a length of 0 or nonexistentempty-email: The email had a length of 0 or nonexistentemail-already-taken: The email given is in use by another userinvalid-email: The email given was invalidpassword-too-short: The password was too short (minimum length of 6 chars)passwords-no-match: The password and confirmpassword do not match.Email of the user being signed in
\n","type":"text"},{"key":"password","value":"Password of the user being signed in
\n","type":"text"}]},"url":"https://api.gethighlow.com/auth/sign_in","description":"Checks credentials and returns an authorization token if valid.
\n{\n access: String,\n refresh: String,\n uid: String,\n error: String*\n}\nincorrect-email-or-password: The username or password was incorrectuser-no-exist: There is no user with the given emailThe new password for the user
\n","type":"text"},{"key":"confirmpassword","value":"The password confirmation (should be equal to password)
\n","type":"text"}]},"url":"https://api.gethighlow.com/auth/password_reset/Reset's a users password. The reset_id probided in the URL must be a valid authorization token.
Note: You will likely never have to use this endpoint, as it will instead appear as a link in the password reset email.
\n{\n status: String,\n error: String\n}\nERROR-INVALID-RESET-ID: The reset id provided in the URL was invalidpasswords-no-match: The password and confirmpassword do not matchEmail of the user who forgot their password
\n","type":"text"}]},"url":"https://api.gethighlow.com/auth/forgot_password","description":"Sends an email with a password reset link.
\n{\n status: String,\n error: String\n}\nuser-no-exist: No user exists with the given emailDetermines whether a given authorization token is valid. Usually, this is handled automatically on the backend, so you probably won't need this endpoint.
\n{\n uid: String,\n error: String\n}\nERROR-INVALID-TOKEN: The token given was invalidA refresh token used to retrieve a new access token
\n","type":"text"}]},"url":"https://api.gethighlow.com/auth/refresh_access","description":"Attempts to create a new access token based on a given refresh token.
\n{\n access: String,\n error: String\n}\nERROR-INVALID-REFRESH-TOKEN: The refresh token provided was invalidThe firstname of the user, obtained by the OAuth authentication process.
\n","type":"text"},{"key":"lastname","value":"Doe","description":"The lastname of the user, obtained by the OAuth authentication process.
\n","type":"text"},{"key":"email","value":"johndoe@example.com","description":"The email of the user, obtained by the OAuth authentication process.
\n","type":"text"},{"key":"profileimage","value":"https://example.com/johndoe.png","description":"The profileimage URL of the user obtained by the OAuth authentication process.
\n","type":"text"},{"key":"provider_key","value":"The unique key used to identify the user, obtained by the OAuth authentication process.
\n","type":"text"},{"key":"provider_name","value":"google","description":"The name of the provider of the OAuth system used. Can be either 'apple' or 'google'.
\n","type":"text"}]},"url":"https://api.gethighlow.com/auth/oauth/sign_in","description":"Signs in a user with an oauth account rather than with email and password.
\n{\n uid: String,\n access: String,\n refresh: String\n}\nmissing-provider - an OAuth provider key and name were not giveninvalid-provider - the provider given is not supported.missing-information - A firstname, lastname, or email was not given.empty-firstname - the given firstname was emptyempty-lastname - the given lastname was emptyempty-email - the given email was emptyinvalid-email - the given email was not a valid email address.Requests for the auth service
\n","_postman_id":"3b8faaee-35cf-43a9-a9f7-b13224187ecd"},{"name":"User","item":[{"name":"Get user","id":"bc0ea02f-49d3-41e7-9cd6-c04e5b9b0df2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Gets user profile information.
\nOptionally takes url parameter uid, the uid of the user whose profile is requested
{\n uid: String, \n firstname: String,\n lastname: String,\n profileimage: String,\n streak: Int,\n email: String,\n bio: String,\n error: String\n}\nERROR-INVALID-TOKEN: The token provided was invalidGets a specific property of the current user.
\n{\n <property>: <value>,\n error: String\n}\nERROR-INVALID-TOKEN: The token given was invalidSets a specific property of a user.
\n{\n status: String,\n error: String\n}\nERROR-INVALID-TOKEN: The token provided was invalidno-file-uploaded: (When setting profileimage) no file was uploaded to the serverNew first name of user
\n","type":"text"},{"key":"lastname","value":"Doe","description":"New last name of user
\n","type":"text"},{"key":"email","value":"johndoe@example.com","description":"New email of user
\n","type":"text"},{"key":"bio","value":"I'm John Doe, a test user","description":"New description of user
\n","type":"text"}]},"url":"https://api.gethighlow.com/user/set_profile","description":"Sets the current user's profile.
\n{\n status: String,\n error: String\n}\nERROR-INVALID-TOKEN: The token provided was invaliduser-no-exist: No user exists with that uidFlags a user for review by administrators.
\n{\n status: String,\n error: String\n}\nERROR-INVALID-TOKEN: The token provided was invaliduser-no-exist: No user exists with that uidUnflags a user.
\n{\n status: String,\n error: String\n}\nERROR-INVALID-TOKEN: The token provided was invaliduser-no-exist: No user exists with the given uidGets the feed for a user at a given page.
\n{\n feed: [\n {\n user: {\n uid: String,\n firstname: String,\n lastname: String,\n profileimage: String,\n streak: Int,\n bio: String\n },\n highlow: {\n highlowid: String,\n high: String,\n low: String,\n high_image: String,\n low_image: String,\n _date: String,\n _timestamp: String,\n total_likes: Int,\n uid: String,\n liked: Int,\n flagged: Int,\n comments: [\n commentid: String,\n uid: String,\n message: String,\n _timestamp: String,\n firstname: String,\n lastname: String,\n profileimage: String\n ]\n }\n }\n ]\n}\nERROR-INVALID-TOKEN: The token provided was invalidList a user's friends.\nOptionally accepts url parameter uid - the uid of the user whose friends are to be listed. Defaults to current user
{\n friends: [\n {\n uid: String,\n firstname: String,\n lastname: String,\n profileimage: String,\n streak: Int,\n bio: String\n }\n ],\n error: String\n}\nERROR-INVALID-TOKEN: The token given was invalidUnfriends on of the current user's friends.
\n{\n status: String,\n error: String\n}\nERROR-INVALID-TOKEN: The provided token was invalidSends a friend request from the current user to another user.
\n{\n status: String,\n error: String\n}\nERROR-INVALID-TOKEN: The token provided was invalidA keyword search based on the name of the user
\n","type":"text"}]},"url":"https://api.gethighlow.com/user/search","description":"Searches users, usually in order to find new friends.
\n{\n users: [\n {\n user: {\n uid: String,\n firstname: String,\n lastname: String,\n email: String,\n profileimage: String,\n streak: Int, \n bio: String\n },\n rank: Int\n }\n ],\n error: String\n}\nERROR-INVALID-TOKEN: The token provided was invalidLists the pending friendship requests for the current user.
\n{\n requests: [\n {\n uid: String,\n firstname: String,\n lastname: String,\n profileimage: String,\n streak: Int,\n bio: String\n }\n ],\n error: String\n}\nERROR-INVALID-TOKEN: The provided token was invalidAccepts a friendship request for the current user.
\n{\n status: String,\n error: String\n}\nERROR-INVALID-TOKEN: The provided token was invalidGets users High/Lows with minimum information, to be used in displaying a calendar.
\n{\n calendar: [\n {\n highlowid: String,\n _date: String\n }\n ],\n error: String\n}\nERROR-INVALID-TOKEN: The provided token was invalidRequests for the user service
\n","_postman_id":"d7366c4f-1001-4f06-8ef5-a8a99b1adf0a"},{"name":"HighLow","item":[{"name":"Set High","id":"6605f2a7-da52-4495-b8a2-e23a8fd3a8e2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"The text content of the high of a High/Low
\n","type":"text"}]},"url":"https://api.gethighlow.com/highlow/set/high","description":"Sets the high portion of a High/Low.
\nAccepts both a high as text content and a file as an image.
\n{\n status: String,\n error: String\n}\nERROR-INVALID-TOKEN: The provided token was invalidThe text content of the low of a High/Low
\n","type":"text"}]},"url":"https://api.gethighlow.com/highlow/set/low","description":"Sets the low portion of a High/Low.
\nAccepts both a low as text content and a file as an image.
\n{\n status: String,\n error: String\n}\nERROR-INVALID-TOKEN: The provided token was invalidUsed to like a High/Low.
\n{\n status: String,\n total_likes: Int,\n error: String\n}\nERROR-INVALID-TOKEN: The provided token was invalidinvalid-highlowid: No highlow exists with the given idalready-liked: The user has already liked this High/Lownot-allowed: The user is trying to like their own highlowUnlikes a High/Low.
\n{\n status: String,\n total_likes: Int,\n error: String\n}\nERROR-INVALID-TOKEN: The token provided was invalidThe text content of the comment
\n","type":"text"}]},"url":"https://api.gethighlow.com/highlow/comment/Comments on a High/Low.
\n{\n status: String,\n error: String\n}\nERROR-INVALID-TOKEN: The provided token was invalidno-comment: The message provided had a length of 0 or noneinvalid-highlow: No highlow exists with that idGets the High/Low for today belonging to the current user.
\n{\n id: Int,\n highlowid: String,\n uid: String,\n high: String,\n low: String,\n high_image: String,\n low_image: String,\n total_likes: Int,\n _timestamp: String,\n _date: String,\n liked: Int,\n flagged: Int,\n comments: [\n {\n commentid: String,\n uid: String,\n message: String,\n _timestamp: String,\n firstname: String,\n lastname: String,\n profileimage: String\n }\n ]\n}\nERROR-INVALID-TOKEN: The provided token was invalidGets an arbitrary High/Low, given its highlowid.
\n{\n uid: String,\n high: String,\n low: String,\n high_image: String,\n low_image: String,\n total_likes: Int,\n highlowid: String,\n _timestamp: String,\n _date: String,\n liked: Boolean,\n flagged: Boolean,\n comments: [\n {\n commentid: String,\n uid: String,\n message: String,\n _timestamp: String,\n firstname: String,\n lastname: String,\n profileimage: String\n }\n ]\n}\nERROR-INVALID-TOKEN: The provided token was invalidinvalid-highlowid: No High/Low exists with the given idGets the highlows for a given user at a given page.
\nOptionally excepts url parameter uid; the uid of the user whose High/Lows are being fetched
\n{\n highlows: [\n {\n uid: String,\n highlowid: String,\n high: String,\n low: String,\n low_image: String,\n high_image: String,\n _timestamp: String,\n _date: String,\n total_likes: Int,\n flagged: Int,\n liked: Int,\n comments: [\n {\n commentid: String,\n uid: String,\n message: String,\n _timestamp: String,\n firstname: String,\n lastname: String,\n profileimage: String\n }\n ]\n }\n ],\n error: String\n}\nERROR-INVALID-TOKEN: The provided token was invalidThe date string of the High/Low being fetched
\n","type":"text"}]},"url":"https://api.gethighlow.com/highlow/get/date","description":"Gets the High/Low with the given date belonging to the current user.
\n{\n highlowid: String,\n uid: String,\n high: String,\n low: String,\n total_likes: Int,\n high_image: String,\n low_image: String,\n flagged: Int,\n liked: Int,\n _date: String,\n comments: [\n {\n commentid: String,\n uid: String,\n message: String,\n _timestamp: String,\n firstname: String,\n lastname: String,\n profileimage: String\n }\n ]\n}\nERROR-INVALID-TOKEN: The provided token was invalidFlags a High/Low for admin attention.
\n{\n status: String,\n error: String\n}\nERROR-INVALID-TOKEN: The provided token was invalidalready-flagged: The user has already flagged this High/Lowhighlow-no-exist: No High/Low exists with the given highlowidUnflags a High/Low.
\n{\n status: String,\n error: String\n}\nERROR-INVALID-TOKEN: The provided token was invalidGets the comments for a give High/Low.
\n{\n comments: [\n {\n commentid: String,\n uid: String,\n message: String,\n _timestamp: String,\n firstname: String,\n lastname: String,\n profileimage: String\n }\n ],\n error: String\n}\nERROR-INVALID-TOKEN: The provided token was invalidhighlow-no-exist: No highlow exists with the given idDeletes a comment by id.
\n{\n status: String,\n error: String\n}\nERROR-INVALID-TOKEN: The provided token was invalidThe message of the comment
\n","type":"text"}]},"url":"https://api.gethighlow.com/comment/update/Updates a comment with a given id.
\n{\n status: String,\n error: String\n}\nERROR-INVALID-TOKEN: The provided token was invalidno-message: No message was givenRequests to the High/Low service.
\n","_postman_id":"d40b02be-d854-4b47-908a-ddfbd7f477e1"},{"name":"Submit Bug Report","id":"6be947e7-ee69-48b9-b2f6-3437d5d71cfe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"The title of the bug report
\n","type":"text"},{"key":"message","value":"I found a bug...","description":"The message of the bug report
\n","type":"text"}]},"url":"https://api.gethighlow.com/bug_reports/submit","description":"Submits a bug report for admin review.
\n{\n status: String,\n error: String\n}\nERROR-INVALID-TOKEN: The provided token was invalidThe platform of the device being registered
\n","type":"text"},{"key":"device_id","value":"The FCM id of the device
\n","type":"text"}]},"url":"https://api.gethighlow.com/notifications/register","description":"Registers a device to receive push notifications.
\n{\n device_id: String,\n uid: String,\n platform: String,\n error: String\n}\nERROR-INVALID-TOKEN: The provided token was invalid