Becoming You Labs Partner API
  • Documentation
  • API Reference
Information
Assessment
    Get published assessment schemaget
Sessions
    Create an assessment sessionpostGet session statusgetRecord answerspostComplete and score a sessionpostGet session resultsget
Subjects
    Get latest results for one of your usersget
Schemas
powered by Zuplo
Becoming You Labs Partner API
Becoming You Labs Partner API

Assessment

Published assessment schema.


Get published assessment schema

GET
https://api.becomingyou.com
/v1/{product}/assessment

Get published assessment schema › path Parameters

product
​string · enum · required

Assessment product identifier.

Enum values:
values-bridge

Get published assessment schema › Responses

Published question schema.

AssessmentSchema
product
​string
assessmentId
​integer
version
​integer
​Question[]
GET/v1/{product}/assessment
curl https://api.becomingyou.com/v1/:product/assessment \ --header 'Authorization: Bearer <token>'
Example Responses
{ "product": "product", "assessmentId": 0, "version": 0, "questions": [ { "id": 0, "prompt": "prompt", "type": "likert", "group": "group", "position": 0, "required": true, "likertConfig": { "min": 0, "max": 0 }, "choices": [ { "id": 0, "label": "label" } ], "valuesBridgeConfig": { "valueId": 0, "valueName": "valueName", "lifeContext": "ideal", "inverse": true, "omegaWeight": 0 } } ] }
json
application/json

Sessions