Users

register a new user

post

This operation registers a new user in hosted API. After a new user is registered, a scan for this user can be registered with /scans.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

emailstring · email · nullableOptional

The email address of the user

Example: [email protected]

tokenstringRequired

A unique token for the user provided by the partner

Example: unique-user-token

sexstring · enumRequired

The user's sex

Example: malePossible values:

regionstring · enumRequired

The user's region

Example: north_americaPossible values:

usaResidencestringOptional

The user's state of residence

Example: California

birthDatestringRequired

The user's birth date

Example: 1990-01-01

researchConsentbooleanRequired

Whether the user has consented to their data being used for research

Example: true

Responses

201Success

application/json;v=1

post

/users

HTTPcURLJavaScriptPython

POST /users HTTP/1.1
Host: api.hosted.prismlabs.tech
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 322

{
  "email": "[email protected]",
  "token": "unique-user-token",
  "weight": {
    "value": 80,
    "unit": "kg"
  },
  "targetWeight": {
    "value": 80,
    "unit": "kg"
  },
  "height": {
    "value": 1.8,
    "unit": "m"
  },
  "sex": "male",
  "region": "north_america",
  "usaResidence": "California",
  "birthDate": "1990-01-01",
  "researchConsent": true,
  "termsOfService": {
    "accepted": true,
    "version": "1"
  }
}

201Success

{
  "id": "unique-user-id",
  "sex": "male",
  "region": "north_america",
  "usaResidence": "California",
  "birthDate": "1990-01-01",
  "weight": {
    "value": 80,
    "unit": "kg"
  },
  "targetWeight": {
    "value": 70,
    "unit": "kg"
  },
  "height": {
    "value": 1.8,
    "unit": "m"
  },
  "token": "unique-user-token",
  "email": "[email protected]",
  "researchConsent": true
}

get meta data of a user

get

This operation provides the meta data for a specific user.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

tokenstringRequired

A unique token for the user provided by the partner

Example: unique-user-token

Query parameters

unit-systemstring · enumOptional

The unit system in which values will be returned

Possible values:

Responses

200Success

application/json;v=1

idstringRequired

The unique ID of the user

Example: unique-user-id

sexstring · enumRequired

The user's sex

Example: malePossible values:

regionstring · enumRequired

The user's region

Example: north_americaPossible values:

usaResidencestring · nullableOptional

The user's state of residence

Example: California

birthDatestringRequired

The user's birth date

Example: 1990-01-01

tokenstringRequired

A unique token for the user provided by the partner

Example: unique-user-token

emailstring · nullableOptional

The email address of the user

Example: [email protected]

researchConsentbooleanRequired

Whether the user has consented to their data being used for research

Example: true

get

/users/{token}

HTTPcURLJavaScriptPython

GET /users/{token} HTTP/1.1
Host: api.hosted.prismlabs.tech
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

{
  "id": "unique-user-id",
  "sex": "male",
  "region": "north_america",
  "usaResidence": "California",
  "birthDate": "1990-01-01",
  "weight": {
    "value": 80,
    "unit": "kg"
  },
  "targetWeight": {
    "value": 70,
    "unit": "kg"
  },
  "height": {
    "value": 1.8,
    "unit": "m"
  },
  "token": "unique-user-token",
  "email": "[email protected]",
  "researchConsent": true
}

delete a user

delete

This operation deletes a specific user.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

tokenstringRequired

A unique token for the user provided by the partner

Example: unique-user-token

Responses

200Success

application/json;v=1

idstringRequired

The unique ID of the user

Example: unique-user-id

sexstring · enumRequired

The user's sex

Example: malePossible values:

regionstring · enumRequired

The user's region

Example: north_americaPossible values:

usaResidencestring · nullableOptional

The user's state of residence

Example: California

birthDatestringRequired

The user's birth date

Example: 1990-01-01

tokenstringRequired

A unique token for the user provided by the partner

Example: unique-user-token

emailstring · nullableOptional

The email address of the user

Example: [email protected]

researchConsentbooleanRequired

Whether the user has consented to their data being used for research

Example: true

delete

/users/{token}

HTTPcURLJavaScriptPython

DELETE /users/{token} HTTP/1.1
Host: api.hosted.prismlabs.tech
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

{
  "id": "unique-user-id",
  "sex": "male",
  "region": "north_america",
  "usaResidence": "California",
  "birthDate": "1990-01-01",
  "weight": {
    "value": 80,
    "unit": "kg"
  },
  "targetWeight": {
    "value": 70,
    "unit": "kg"
  },
  "height": {
    "value": 1.8,
    "unit": "m"
  },
  "token": "unique-user-token",
  "email": "[email protected]",
  "researchConsent": true
}

update meta data of a user

patch

This operation updates the meta data for a specific user.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

tokenstringRequired

A unique token for the user provided by the partner

Example: unique-user-token

Body

application/json

emailstring · email · nullableOptional

The email address of the user

Example: [email protected]

tokenstringOptional

A unique token for the user provided by the partner

Example: unique-user-token

sexstring · enumOptional

The user's sex

Example: malePossible values:

regionstring · enumOptional

The user's region

Example: north_americaPossible values:

usaResidencestringOptional

The user's state of residence

Example: California

birthDatestringOptional

The user's birth date

Example: 1990-01-01

researchConsentbooleanOptional

Whether the user has consented to their data being used for research

Example: true

Responses

200Success

application/json;v=1

idstringRequired

The unique ID of the user

Example: unique-user-id

sexstring · enumRequired

The user's sex

Example: malePossible values:

regionstring · enumRequired

The user's region

Example: north_americaPossible values:

usaResidencestring · nullableOptional

The user's state of residence

Example: California

birthDatestringRequired

The user's birth date

Example: 1990-01-01

tokenstringRequired

A unique token for the user provided by the partner

Example: unique-user-token

emailstring · nullableOptional

The email address of the user

Example: [email protected]

researchConsentbooleanRequired

Whether the user has consented to their data being used for research

Example: true

patch

/users/{token}

HTTPcURLJavaScriptPython

PATCH /users/{token} HTTP/1.1
Host: api.hosted.prismlabs.tech
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 273

{
  "email": "[email protected]",
  "token": "unique-user-token",
  "weight": {
    "value": 80,
    "unit": "kg"
  },
  "targetWeight": {
    "value": 80,
    "unit": "kg"
  },
  "height": {
    "value": 1.8,
    "unit": "m"
  },
  "sex": "male",
  "region": "north_america",
  "usaResidence": "California",
  "birthDate": "1990-01-01",
  "researchConsent": true
}

200Success

{
  "id": "unique-user-id",
  "sex": "male",
  "region": "north_america",
  "usaResidence": "California",
  "birthDate": "1990-01-01",
  "weight": {
    "value": 80,
    "unit": "kg"
  },
  "targetWeight": {
    "value": 70,
    "unit": "kg"
  },
  "height": {
    "value": 1.8,
    "unit": "m"
  },
  "token": "unique-user-token",
  "email": "[email protected]",
  "researchConsent": true
}