Nest Changelog
1.0.0
9/9/2021
1.0.1
9/9/2021
6 changed endpoints Collapse changed endpoints
POST /auth 
Sign in with email address and password
Response Body
{
+ data: List<{
+ family?: List<{
+ id?: number,
+ image?: {
+ default?: string,
+ large?: string,
+ medium?: string,
+ small?: string,
+ },
+ nickname?: string,
+ }>,
+ guid?: string,
+ jwt?: string,
+ plan?: {
+ features?: record,
+ id?: number,
+ name?: string,
+ },
+ userId?: number,
+ }>,
}GET /auth/{sessionGuid} 
Refresh the token
Response Body
{
+ data: List<{
+ family?: List<{
+ id?: number,
+ image?: {
+ default?: string,
+ large?: string,
+ medium?: string,
+ small?: string,
+ },
+ nickname?: string,
+ }>,
+ guid?: string,
+ jwt?: string,
+ plan?: {
+ features?: record,
+ id?: number,
+ name?: string,
+ },
+ userId?: number,
+ }>,
}GET /users 
Get all users
Response Body
{
+ data: List<{
+ createdBy?: record,
+ dateActivated?: number,
+ dateBirth?: string,
+ dateCreated?: number,
+ dateUpdated?: number,
+ email?: string,
+ firstName?: string,
+ gender?: {
+ text?: string,
+ value?: string,
+ },
+ height?: record,
+ id?: number,
+ image?: {
+ default?: string,
+ large?: string,
+ medium?: string,
+ small?: string,
+ },
+ lastName?: string,
+ nickname?: string,
+ parentId?: number,
+ purchased?: record,
+ roles?: List<string>,
+ stripe?: record,
+ updatedBy?: {
+ id?: number,
+ },
+ weight?: record,
+ }>,
}GET /users/{userId} 
Get a specific user by id
Response Body
{
+ data: List<{
+ createdBy?: record,
+ dateActivated?: number,
+ dateBirth?: string,
+ dateCreated?: number,
+ dateUpdated?: number,
+ email?: string,
+ firstName?: string,
+ gender?: {
+ text?: string,
+ value?: string,
+ },
+ height?: record,
+ id?: number,
+ image?: {
+ default?: string,
+ large?: string,
+ medium?: string,
+ small?: string,
+ },
+ lastName?: string,
+ nickname?: string,
+ parentId?: number,
+ purchased?: record,
+ roles?: List<string>,
+ stripe?: record,
+ updatedBy?: {
+ id?: number,
+ },
+ weight?: record,
+ }>,
}PATCH /users/{userId} 
Edit this user
Response Body
{
+ data: List<{
+ createdBy?: record,
+ dateActivated?: number,
+ dateBirth?: string,
+ dateCreated?: number,
+ dateUpdated?: number,
+ email?: string,
+ firstName?: string,
+ gender?: {
+ text?: string,
+ value?: string,
+ },
+ height?: record,
+ id?: number,
+ image?: {
+ default?: string,
+ large?: string,
+ medium?: string,
+ small?: string,
+ },
+ lastName?: string,
+ nickname?: string,
+ parentId?: number,
+ purchased?: record,
+ roles?: List<string>,
+ stripe?: record,
+ updatedBy?: {
+ id?: number,
+ },
+ weight?: record,
+ }>,
}GET /users/{userId}/family 
Get child accounts of this user
Response Body
{
+ data: List<{
+ createdBy?: record,
+ dateActivated?: number,
+ dateBirth?: string,
+ dateCreated?: number,
+ dateUpdated?: number,
+ email?: string,
+ firstName?: string,
+ gender?: {
+ text?: string,
+ value?: string,
+ },
+ height?: record,
+ id?: number,
+ image?: {
+ default?: string,
+ large?: string,
+ medium?: string,
+ small?: string,
+ },
+ lastName?: string,
+ nickname?: string,
+ parentId?: number,
+ purchased?: record,
+ roles?: List<string>,
+ stripe?: record,
+ updatedBy?: {
+ id?: number,
+ },
+ weight?: record,
+ }>,
}