Users | API Reference

API Reference

Register a new user

post

/users

Authorizations

Body

birthYearnumberrequired

The user's birth year

Example: 1990

sexenumrequired

Describes the user's sex

Example: female

Options: male, female, neutral, undefined

regionenumrequired

Describes the region where the user is being registered

Example: north_america

Options: africa, asia, caribbean, central_america, europe, north_america, oceania, south_america, unspecified

weightall of

Describes the user's weight in kilograms (kg) or pounds (lb)

Example: {"value":80,"unit":"kg"}

heightall of

Describes the user's height in meters (m) or inches (in)

Example: {"value":1.7,"unit":"m"}

Responses

application/json;v=1

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.prismlabs.tech/users' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{"birthYear":1990,"sex":"female","region":"north_america","weight":{"value":80,"unit":"kg"},"height":{"value":1.7,"unit":"m"}}'

201

400

401

403

422

500

{
  "birthYear": 1990,
  "id": "7f2ec6e0-b06d-42b1-b2a1-fff59a458490",
  "sex": "female",
  "region": "north_america",
  "weight": {
    "value": 80,
    "unit": "kg"
  },
  "height": {
    "value": 1.7,
    "unit": "m"
  }
}

Fetch a user

get

/users/{userId}

Authorizations

Path parameters

userIdstringrequired

Query parameters

weight-unitenum

The unit in which the weight will be returned

Options: kg, lb

height-unitenum

The unit in which the height will be returned

Options: m, in

Responses

application/json;v=1

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.prismlabs.tech/users/{userId}' \
  --header 'Authorization: Bearer JWT'

200

401

403

404

500

{
  "birthYear": 1990,
  "id": "7f2ec6e0-b06d-42b1-b2a1-fff59a458490",
  "sex": "female",
  "region": "north_america",
  "weight": {
    "value": 80,
    "unit": "kg"
  },
  "height": {
    "value": 1.7,
    "unit": "m"
  }
}

Update a user

IMPORTANT: A user should be updated with current information (e.g. weight) before the creation a new scan.

patch

/users/{userId}

Authorizations

Path parameters

userIdstringrequired

Query parameters

weight-unitenum

The unit in which the weight will be returned

Options: kg, lb

height-unitenum

The unit in which the height will be returned

Options: m, in

Body

birthYearnumber

The user's birth year

Example: 1990

sexenum

Describes the user's sex

Example: female

Options: male, female, neutral, undefined

regionenum

Describes the region where the user is being registered

Example: north_america

Options: africa, asia, caribbean, central_america, europe, north_america, oceania, south_america, unspecified

weightall of

Describes the user's weight in kilograms (kg) or pounds (lb)

Example: {"value":80,"unit":"kg"}

heightall of

Describes the user's height in meters (m) or inches (in)

Example: {"value":1.7,"unit":"m"}

Responses

application/json;v=1

cURL

JavaScript

Python

HTTP

curl -L \
  --request PATCH \
  --url 'https://api.prismlabs.tech/users/{userId}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{"birthYear":1990,"sex":"female","region":"north_america","weight":{"value":80,"unit":"kg"},"height":{"value":1.7,"unit":"m"}}'

200

400

401

403

422

500

{
  "birthYear": 1990,
  "id": "7f2ec6e0-b06d-42b1-b2a1-fff59a458490",
  "sex": "female",
  "region": "north_america",
  "weight": {
    "value": 80,
    "unit": "kg"
  },
  "height": {
    "value": 1.7,
    "unit": "m"
  }
}