{"info":{"_postman_id":"5eeba2f1-73f7-42a9-af10-ac5502018d71","name":"Enterprise API v1","description":"

FitRankings' Enterprise API provides the tools to leverage your users' fitness data in conjunction with the FitRankings platform.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"6096913","collectionId":"5eeba2f1-73f7-42a9-af10-ac5502018d71","publishedId":"TzCFgASk","public":true,"customColor":{"top-bar":"323232","right-sidebar":"323232","highlight":"ECA620"},"publishDate":"2021-03-22T22:36:23.000Z"},"item":[{"name":"Authorization","item":[{"name":"Obtain Tokens","id":"4f59b2aa-9946-4e43-9aa3-d7cee2e74a16","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{}},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"grant_type","value":"","description":"

Required. Must be authorization_code

\n","type":"text"},{"key":"code","value":"","description":"

Required. The authorization code received in the previous step.

\n","type":"text"},{"key":"client_id","value":"","description":"

Required. A key provided by FitRankings.

\n","type":"text"},{"key":"client_secret","value":"","type":"text","description":"

Required. A secret provided by FitRankings.

\n"},{"key":"redirect_uri","value":"","description":"

Required. Client provided redirect_uri

\n","type":"text"}]},"url":"https://api.fitrankings.com/v1/token","description":"

A valid request to this endpoint will use Content-Type: application/x-www-form-urlencoded. A pair of tokens will be issued and available in the response body. These tokens must be saved to operate on a user's behalf. The access_token is used to authenticate every request for a user's resources. The refresh_token is used to obtain a new pair of tokens once the access token expires. The expires_in attribute declares the number of seconds until the access token expires. The refresh token will either expire immediately if it is used or automatically after 3 days.

\n","urlObject":{"protocol":"https","path":["v1","token"],"host":["api","fitrankings","com"],"query":[],"variable":[]}},"response":[{"id":"d9bba7a7-e958-465d-be1b-8b8ff4c73420","name":"Obtain Tokens","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"grant_type","value":"authorization_code","type":"text"},{"key":"code","value":"redacted","type":"text"},{"key":"client_id","value":"redacted","type":"text"},{"key":"client_secret","value":"redacted","type":"text"},{"key":"redirect_uri","value":"https://example.com/noexist","type":"text"}],"options":{"raw":{"language":"json"}}},"url":"https://api.fitrankings.com/v1/token"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"token_type\": \"Bearer\",\n \"scope\": \"read\",\n \"expires_in\": \"28800\",\n \"access_token\": \"\",\n \"refresh_token\": \"\"\n}"}],"_postman_id":"4f59b2aa-9946-4e43-9aa3-d7cee2e74a16"},{"name":"Refresh Tokens","id":"3c4e3bdb-f84f-435a-8f6e-6ccc95613a6c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"grant_type","value":"","description":"

Required. Must be refresh_token

\n","type":"text"},{"key":"refresh_token","value":"","description":"

Required. The refresh_token from your last request for new tokens.

\n","type":"text"},{"key":"client_id","value":"","description":"

Required. A key provided by FitRankings.

\n","type":"text"},{"key":"client_secret","value":"","description":"

Required. A secret provided by FitRankings.

\n","type":"text"}]},"url":"https://api.fitrankings.com/v1/token","description":"

A valid request to this endpoint will use Content-Type: application/x-www-form-urlencoded. It will issue a new pair of tokens. A new access_token will be included in the response body, along with the number of seconds it expires_in. Additionally, a new refresh_token.

\n","urlObject":{"protocol":"https","path":["v1","token"],"host":["api","fitrankings","com"],"query":[],"variable":[]}},"response":[{"id":"c752c898-2d07-40e3-a5c8-03e91e6259f8","name":"Refresh Tokens","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"grant_type","value":"refresh_token","type":"text"},{"key":"refresh_token","value":"redacted","type":"text"},{"key":"client_id","value":"redacted","type":"text"},{"key":"client_secret","value":"redacted","type":"text"}],"options":{"raw":{"language":"json"}}},"url":"https://api.fitrankings.com/v1/token"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"token_type\": \"Bearer\",\n \"scope\": \"read\",\n \"expires_in\": \"28800\",\n \"access_token\": \"\",\n \"refresh_token\": \"\"\n}"}],"_postman_id":"3c4e3bdb-f84f-435a-8f6e-6ccc95613a6c"}],"id":"2beed239-5876-4f7c-905c-09baf635d873","description":"

FitRankings' Enterprise API uses the OAuth2 protocol. You must obtain permission to access a user's resources on their behalf. Outlined below is the Authorization Code grant that your application must implement to request permission and obtain the tokens that prove you are authorized.

A user must authorize your application to access their fitness data. You may prompt a user to authorize your application by sending them to the Authorization URL with the expected URL parameters encoded.

Authorization URL: https://api.fitrankings.com/v1/authorize

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Expected URL Parameters
`response_type`	(Required) The value must be: `code`
`client_id`	(Required) An API key provided by FitRankings.
`redirect_url`	(Required) A view where users will be directed having completed authentication and authorization. The value must be URL-encoded. Must match the list of URLs provided to FitRankings when registering for Enterprise API access.
`state`	(Optional) Alphanumeric string.This parameter can be used to prevent cross- site request forgery (CSRF) attacks

When a user is directed to the Authorization URL, they will be prompted to:

Signup or Login with FitRankings
Connect a device
Authorize your application

Finally, the user will be returned to the redirect_uri with the following attributes available in the URL. These values should be used to obtain tokens in the following POST request.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Available URL Parameters
`code`	An authorization code to be used in the following request for tokens. Excluded if authorization was not granted.
`state`	The (optional) alphanumeric string provided to FitRankings by your application.
`scope`	The permissions granted to your application.
`error`	Included if authorization was not granted.

Connect a Device

As noted above, a user will have the opportunity to connect a device in the same sequence they authorize your application. They may connect to one of the following: Apple Health, Garmin, Fitbit, MapMyFitness, Oura Ring, Suunto, Wahoo, Polar, Coros, Google Fit, Runkeeper.

In some cases a user may wish to add or update connections later. This can be facilitated in two ways:

You may direct the user to the Authorization URL for a second time. If their previous authorization can be validated automatically, they will not be prompted again. After making a change to their connections, the user will click \"Authorize\" and will be sent to the redirect_uri provided. A new authorization code will be issued and previous tokens will be revoked.
\n
Ask users to manage their connections on FitRankings.com. When possible, a user will land on their profile page without needing to login. From their profile a user will be able to: manually add activities, initiate syncing of all their devices, contact FitRankings support.
\n

\n","_postman_id":"2beed239-5876-4f7c-905c-09baf635d873"},{"name":"Resources","item":[{"name":"Retrieve User","id":"e4bc833f-c2cd-4434-af6a-f865be9e5774","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.fitrankings.com/v1/user/","description":"

User Model

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Atrribute	Type	Description
`first_name`	string	The user's first name.
`last_name`	string	The user's surname.
`gender`	string	The user's gender. Possible values are: Male, Female, Non-binary, Not Specified
`age`	number	The user's age.
`height`	number	The user's height, in centimeters.
`weight`	number	The user's weight, in kilograms.
`resting_heart_rate`	number	The user's resting heart rate, if available.
`utc_offset`	number	The difference between UTC and the user's timezone, in seconds. East of UTC this value will be negative.

","urlObject":{"protocol":"https","path":["v1","user",""],"host":["api","fitrankings","com"],"query":[],"variable":[]}},"response":[{"id":"66ae9e81-9972-4de5-bedf-2a8b021adf33","name":"Retrieve User","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"}],"url":"https://api.fitrankings.com/v1/user/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"first_name\": \"John\",\n \"last_name\": \"Smith\",\n \"gender\": \"Male\",\n \"age\": 29,\n \"resting_heart_rate\": 56.0,\n \"height\": 190.5,\n \"weight\": 88.45,\n \"utc_offset\": -18000.0\n}"}],"_postman_id":"e4bc833f-c2cd-4434-af6a-f865be9e5774"},{"name":"List Workouts","id":"af3917ae-e781-4adc-81e4-c0f7e7d0b8b7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.fitrankings.com/v1/workouts","description":"

Workout Model

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Atribute	Type	Description
`id`	number	A unique identifier of the workout activity.
`start`	string	The date and time the workout was started, in ISO format.
`duration`	number	The total time elapsed during the workout.
`distance`	number	The distance completed during the workout, in meters.
`steps`	number	The number of steps completed during the workout.
`elevation_gain`	number	The total elevation gained during the workout, in meters, if available.
`calories`	number	The total calories burned during the workout.
`met_minutes`	number	The corresponding met minutes calculated for the workout.
`activity_type`	string	The type of workout completed. See below for possible values.
`avg_heart_rate`	number	The average heart rate during the workout, if available.
`max_heart_rate`	number	The maximum heart rate reached during the workout, if available.

Activity Types

May be equal to any one of the following: \"WALK\", \"RUN\", \"SWIM\", \"BIKE\", \"HIKE\", \"SKI\", \"YOGA\", \"WEIGHT_TRAINING\", \"ROLLER_SKATE\", \"SURF\", \"STAIR_STEPPER\", \"ROW\", \"CANOE\", \"DANCE\", \"BOWL\", \"SAIL\", \"OTHER\", \"CROSSFIT\", \"SUP\", \"KAYAK\", \"ROCK_CLIMB\", \"KITESURF\", \"SNOWSHOE\", \"WINDSURF\", \"SITUP\", \"PUSHUP\", \"BASKETBALL\", \"GYMNASTICS\", \"DIVE\", \"BOOTCAMP\", \"ELLIPTICAL\", \"SNOWBOARD\", \"TENNIS\", \"PARAGLIDE\", \"ICE_SKATE\", \"HORSEBACK_RIDE\", \"BREATHING\", \"GOLF\", \"FIGHT\", \"VOLLEYBALL\"

\n","urlObject":{"protocol":"https","path":["v1","workouts"],"host":["api","fitrankings","com"],"query":[{"disabled":true,"description":{"content":"

Required. The date and time whereby all workouts returned will have occured after. Should be in ISO format, like: YYYY-MM-DDThh:mm:ss

\n","type":"text/plain"},"key":"start","value":""},{"disabled":true,"description":{"content":"

Optional. The date and time whereby all workouts returned will have occured before. Defaults to the current time in UTC if omitted. Should be in ISO format, like: YYYY-MM-DDThh:mm:ss

\n","type":"text/plain"},"key":"end","value":null},{"disabled":true,"description":{"content":"

Optional. Defaults to 1.

\n","type":"text/plain"},"key":"page","value":""},{"disabled":true,"description":{"content":"

Optional. Defaults to 25; must be no greater than 50.

\n","type":"text/plain"},"key":"page_size","value":""}],"variable":[]}},"response":[{"id":"dc9566eb-c8f1-4c4b-9182-57ce821d12ce","name":"List Workouts","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"}],"url":{"raw":"https://api.fitrankings.com/v1/workouts?start=2021-03-15T00:00:00","protocol":"https","host":["api","fitrankings","com"],"path":["v1","workouts"],"query":[{"key":"start","value":"2021-03-15T00:00:00"},{"key":"end","value":"2021-03-31T23:59:59","disabled":true},{"key":"page","value":"1","disabled":true},{"key":"page_size","value":"25","disabled":true}]}},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 12651490,\n \"start\": \"2021-03-16T21:52:49+00:00\",\n \"duration\": 4008.072,\n \"distance\": 0.0,\n \"steps\": 0,\n \"elevation_gain\": 0.0,\n \"calories\": 364.0,\n \"met_minutes\": 304.9853,\n \"activity_type\": \"WEIGHT_TRAINING\",\n \"avg_heart_rate\": 108.0,\n \"avg_speed\": 0.0,\n \"max_heart_rate\": 131.0\n },\n {\n \"id\": 12651491,\n \"start\": \"2021-03-16T19:56:52+00:00\",\n \"duration\": 3640.528,\n \"distance\": 0.0,\n \"steps\": 1227,\n \"elevation_gain\": 0.0,\n \"calories\": 500.0,\n \"met_minutes\": 418.9359,\n \"activity_type\": \"OTHER\",\n \"avg_heart_rate\": 154.0,\n \"avg_speed\": 0.0,\n \"max_heart_rate\": null\n }\n]"}],"_postman_id":"af3917ae-e781-4adc-81e4-c0f7e7d0b8b7"},{"name":"List Sleep","id":"eab4ce35-6241-4a5e-a0dc-663e44099b73","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.fitrankings.com/v1/sleep","description":"

Sleep Model

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Atrribute	Type	Description
`id`	number	A unique identifier of the sleep activity.
`start`	string	The date and time sleep was started, in ISO format.
`duration`	number	The total time elapsed during the entire period of sleep, in seconds.
`light_sleep_duration`	number	The time elapsed during light periods of sleep, in seconds.
`deep_sleep_duration`	number	The time elapsed during deep periods of sleep, in seconds.
`rem_sleep_duration`	number	The time elapsed during REM sleep periods, in seconds.
`avg_heart_rate`	number	The average heart rate while sleeping, if available. This can also be interpreted as resting heart rate.
`max_heart_rate`	number	The maximum heart rate reached while sleeping, if available.
`min_heart_rate`	number	The minimum heart rate reached reached while sleeping, if available.
`respiratory_rate`	number	The average number of breaths per minute while sleeping, if available.

","urlObject":{"protocol":"https","path":["v1","sleep"],"host":["api","fitrankings","com"],"query":[{"disabled":true,"description":{"content":"

Required. The date and time whereby all sleep activities returned will have occured after. Should be in ISO format, like: YYYY-MM-DDThh:mm:ss

\n","type":"text/plain"},"key":"start","value":""},{"disabled":true,"description":{"content":"

Optional. The date and time whereby all sleep activities returned will have occured before. Defaults to the current time in UTC if omitted. Should be in ISO format, like: YYYY-MM-DDThh:mm:ss

\n","type":"text/plain"},"key":"end","value":""},{"disabled":true,"description":{"content":"

Optional. Defaults to 1.

\n","type":"text/plain"},"key":"page","value":""},{"disabled":true,"description":{"content":"

Optional. Defaults to 25; must be no greater than 50.

\n","type":"text/plain"},"key":"page_size","value":""}],"variable":[]}},"response":[{"id":"fd69e1bf-eee7-4fae-88eb-c31e1924b2f9","name":"List Sleep","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"}],"url":{"raw":"https://api.fitrankings.com/v1/sleep?start=2021-03-27T00:00:00&end=2021-03-27T23:59:59","protocol":"https","host":["api","fitrankings","com"],"path":["v1","sleep"],"query":[{"key":"start","value":"2021-03-27T00:00:00"},{"key":"end","value":"2021-03-27T23:59:59"},{"key":"page","value":"1","disabled":true},{"key":"page_size","value":"25","disabled":true}]}},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 12651585,\n \"start\": \"2021-03-27T02:49:17+00:00\",\n \"duration\": 27540.0,\n \"light_sleep_duration\": 16590.0,\n \"deep_sleep_duration\": 8040.0,\n \"rem_sleep_duration\": 1470.0,\n \"max_heart_rate\": 66.0,\n \"avg_heart_rate\": 55.32,\n \"min_heart_rate\": 45.0,\n \"respiratory_rate\": 14.625\n }\n]"}],"_postman_id":"eab4ce35-6241-4a5e-a0dc-663e44099b73"},{"name":"Retrieve Daily Summary","id":"696eb589-bf17-446f-9084-b09c32113963","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.fitrankings.com/v1/summary","description":"

Summary Model

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Atrribute	Type	Description
`workouts`	number	The number of workouts completed on the provided date.
`duration`	number	The total elapsed time during workouts.
`distance`	number	The total distance traversed throughout the day, including workouts.
`steps`	number	The total steps taken throughout the day, including workouts.
`elevation_gain`	number	The total elevation climbed throughout the day, including workouts.
`calories`	number	The total calories burned with workouts.
`met_minutes`	number	The total met minutes completed with workouts.
`avg_heart_rate`	number	The daily average heart rate, if available.
`max_heart_rate`	number	The maximum heart rate reached on the provided date, if available.

","urlObject":{"protocol":"https","path":["v1","summary"],"host":["api","fitrankings","com"],"query":[{"disabled":true,"description":{"content":"

Required. The calendar date for which a summary is to be provided. Should be in ISO format, like: YYYY-MM-DD.

\n","type":"text/plain"},"key":"date","value":null}],"variable":[]}},"response":[{"id":"17f1a6fc-58d8-4916-a61c-e688d374bdfd","name":"Retrieve Daily Summary","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"}],"url":{"raw":"https://api.fitrankings.com/v1/summary?date=2021-03-09","protocol":"https","host":["api","fitrankings","com"],"path":["v1","summary"],"query":[{"key":"date","value":"2021-03-09"}]}},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"workouts\": 2,\n \"duration\": 6773.531,\n \"distance\": 5426.9314,\n \"steps\": 1255,\n \"elevation_gain\": 0.0,\n \"calories\": 748.0,\n \"met_minutes\": 626.7281,\n \"avg_heart_rate\": 108.0,\n \"max_heart_rate\": 165.0\n}"}],"_postman_id":"696eb589-bf17-446f-9084-b09c32113963"}],"id":"7efbeae4-ba4f-4761-900d-4953f793d2d4","description":"

The following resources may be used to understand a user's fitness activity. Each successful request will respond with the applicable resource corresponding to the user whose access_token is provided. Every request must include a user's access_token in the headers, like so: Authorization: Bearer <access_token>

\n","event":[{"listen":"prerequest","script":{"id":"c01141d7-f0bc-434d-8853-ca69bd37a44d","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"b1ad9ded-88dc-4eee-92a0-8acf81e97135","type":"text/javascript","exec":[""]}}],"_postman_id":"7efbeae4-ba4f-4761-900d-4953f793d2d4"}],"event":[{"listen":"prerequest","script":{"id":"3331277d-ad79-4412-96ae-faa0bdd9ec7e","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"0fee5cc0-3aa6-4048-ace7-510a3b57edf5","type":"text/javascript","exec":[""]}}],"variable":[{"key":"baseUrl","value":"https://v1.fitrankings.com"}]}