Retrieve User

You can retrieve a user details using our API.

Endpoint Url

Environment	Url
Sandbox	https://partners-sandbox.ftmtapi.com/users/retrieve
Prod	https://partners.ftmtapi.com/users/retrieve

Request fields

Field	Type	Description
email	string	The email address of the user (unique ID).

Response

Response definitions of the user object (Key values only)

Field	Type	Description
bodyProfile > energyLevel	number	1 for Low 2 for Medium 3 for High
bodyProfile > selfFeeling	number	ranked from 1 to 5, the highest the best the feeling is
goals > days	array	List of days of the week the goal is assigned to 1 = Monday

Days as numeric follow this pattern:

• 1: Monday
• 2: Tuesday
• 3: Wednesday
• 4: Thursday
• 5: Friday
• 6: Saturday
• 7: Sunday

Available categories and subcategories for Goals

Category	Subcategory
Core	Nutrition
Core	Activity
Core	General
Additional	Nutrition
Additional	Activity
Additional	General
Obstacle	Nutrition
Obstacle	Activity
Obstacle	General

Response is always in JSON format.

{
  "email": "string",
  "firstname": "string",
  "lastname": "string",
  "phonenumber": "string",
  "dateOfBirth": "string",
  "gender": "string",
  "height": "string",
  "weight": "number",
  "pregnant": "boolean",
  "bodyProfile": [
    {
      "waist": "number",
      "measurmentDate": "string",
      "energyLevel": "number",
      "heartRate": "number",
      "selfFeeling": "number",
      "weight": "number"
    }
  ],
  "goals": [
    {
      "goalId": "string",
      "assignementTime": "string",
      "category": "string",
      "subCategory": "string",
      "days": [
        "number"
      ],
      "dayPerWeek": "number",
      "description": "string",
      "goal": "string",
      "status": "string",
      "title": "string",
      "tracking": [
        {
          "date": "string",
          "progress": "string"
        }
      ]
    }
  ],
  "metadata": {
    "key": "value"
  }
}

Full example of a call made with axios

const axios = require('axios');

const res = axios({
  url: 'https://partners.ftmtapi.com/users/retrieve',
  method: 'post',
  data: {
    email: 'jane@doe.com',
  },
  headers: {
    Authorization: 'Bearer <YOUR_API_KEY>',
    'Fitmate-Version': '2023-08-01'
  }
})