Akan.js

Constant Schema Docs

Database models, scalar models, enums, and relations from ConstantRegistry.

Database Models

Scalar Models

Enums

Relations

ActionLog

actionLog

ActionLog

Full

9 fields

Key	Type	Required	Field Type	Relation	Default	Constraints	Enum	Description
id ID	ID	Required	property	-	null	-	-	Unique ID value
createdAt CreatedAt	Date	Required	property	-	null	-	-	Data created time
updatedAt UpdatedAt	Date	Required	property	-	null	-	-	Data updated time
removedAt RemovedAt	Date	Optional	property	-	null	-	-	Data removed time
type Type	String	Required	property	-	null	-	-	Type
target Target	ID	Required	property	-	null	-	-	Target
user User	ID	Required	property	-	null	-	-	User
action Action	String	Required	property	-	null	-	-	Action
value Value	Int	Required	property	-	0	-	-	Value

Admin

admin

Admin is a person who manages the system, that has a data managent and system monitoring authority.

Admin

Full

8 fields

Key	Type	Required	Field Type	Relation	Default	Constraints	Enum	Description
id ID	ID	Required	property	-	null	-	-	Unique ID value
createdAt CreatedAt	Date	Required	property	-	null	-	-	Data created time
updatedAt UpdatedAt	Date	Required	property	-	null	-	-	Data updated time
removedAt RemovedAt	Date	Optional	property	-	null	-	-	Data removed time
accountId Account ID	String	Required	property	-	null	text:searchcustom validate	-	Account ID Description
password Password	String	Optional	property	-	null	minlength 8	-	Password Description
roles Roles	[String]	Required	property	-	[]	-	manageradminsuperAdmin	Roles Description
lastLoginAt Last Login	Date	Required	property	-	[function]	-	-	Last Login Description

Banner

banner

Banner is a temporary notice informations that is displayed on the top or in front of the page

Banner

Full

13 fields

Key	Type	Required	Field Type	Relation	Default	Constraints	Enum	Description
id ID	ID	Required	property	-	null	-	-	Unique ID value
createdAt CreatedAt	Date	Required	property	-	null	-	-	Data created time
updatedAt UpdatedAt	Date	Required	property	-	null	-	-	Data updated time
removedAt RemovedAt	Date	Optional	property	-	null	-	-	Data removed time
category Category	String	Optional	property	-	null	-	-	Category of banner, displayed on the top
title Title	String	Optional	property	-	null	-	-	Title of banner, displayed on the top
content Content	String	Optional	property	-	null	-	-	Content of banner, displayed on the bottom
image Image	File	Optional	property	reference	null	-	-	Image of banner, displayed on the center
href Href	String	Required	property	-	null	-	-	Href of banner, link to other page
target Target	String	Required	property	-	_self	-	_blank_self	Target configuration of <a> tag in banner
from From	Date	Required	property	-	"2026-05-30T19:59:46.530Z"	-	-	Start date of banner
to To	Date	Optional	property	-	null	-	-	End date of banner
status Status	String	Required	property	-	active	-	activedisplaying	Status of banner

BizAccount

bizAccount

BizAccount description

BizAccount

Full

11 fields

Key	Type	Required	Field Type	Relation	Default	Constraints	Enum	Description
id ID	ID	Required	property	-	null	-	-	Unique ID value
createdAt CreatedAt	Date	Required	property	-	null	-	-	Data created time
updatedAt UpdatedAt	Date	Required	property	-	null	-	-	Data updated time
removedAt RemovedAt	Date	Optional	property	-	null	-	-	Data removed time
org Org	LightOrg	Required	property	reference	null	-	-	Org
type Type	String	Required	property	-	private	-	privatepublic	Type
name Name	String	Required	property	-	null	-	-	Name
email Email	String	Required	property	-	null	-	-	Email
phone Phone	String	Optional	property	-	null	-	-	Phone
image Image	File	Optional	property	reference	null	-	-	Image
users Users	[LightUser]	Required	property	reference	[]	-	-	Users

BizCard

bizCard

BizCard description

BizCard

Full

18 fields

Key	Type	Required	Field Type	Relation	Default	Constraints	Enum	Description
id ID	ID	Required	property	-	null	-	-	Unique ID value
createdAt CreatedAt	Date	Required	property	-	null	-	-	Data created time
updatedAt UpdatedAt	Date	Required	property	-	null	-	-	Data updated time
removedAt RemovedAt	Date	Optional	property	-	null	-	-	Data removed time
org Org	LightOrg	Required	property	reference	null	-	-	Org of bizCard
name Name	String	Required	property	-	null	-	-	Name of bizCard
auxName Auxiliary Name	String	Optional	property	-	null	-	-	Auxiliary name of bizCard
bizLicense Biz License	LightBizLicense	Optional	property	reference	null	-	-	Biz license of bizCard
companyName Company Name	String	Required	property	-	null	-	-	Company name of bizCard
auxCompanyName Auxiliary Company Name	String	Optional	property	-	null	-	-	Auxiliary company name of bizCard
department Department	String	Optional	property	-	null	-	-	Department of bizCard
position Position	String	Optional	property	-	null	-	-	Position of bizCard
email Email	String	Required	property	-	null	-	-	Email of bizCard
phone Phone	String	Required	property	-	null	custom validate	-	Phone of bizCard
homepage Homepage	String	Optional	property	-	null	-	-	Homepage of bizCard
frontImage Front	File	Optional	property	reference	null	-	-	Front image of bizCard
backImage Back	File	Optional	property	reference	null	-	-	Back image of bizCard
status Status	String	Required	property	-	active	-	activeresigned	Status of the BizCard

BizContract

bizContract

BizContract description

BizContract

Full

22 fields

Key	Type	Required	Field Type	Relation	Default	Constraints	Enum	Description
id ID	ID	Required	property	-	null	-	-	Unique ID value
createdAt CreatedAt	Date	Required	property	-	null	-	-	Data created time
updatedAt UpdatedAt	Date	Required	property	-	null	-	-	Data updated time
removedAt RemovedAt	Date	Optional	property	-	null	-	-	Data removed time
org Org	LightOrg	Required	property	reference	null	-	-	Organization of the bizContract
project Project	LightProject	Optional	property	reference	null	-	-	Project of the bizContract
estSheet EstSheet	String	Optional	property	-	null	-	-	EstSheet of the bizContract
bizLicenses Biz Licenses	[LightBizLicense]	Required	property	reference	[]	-	-	Biz Licenses of the bizContract
type Type	String	Required	property	-	null	-	salesoftwareDevelopsoftwareManageconsultingservice	Type of the bizContract
title Title	String	Required	property	-	null	-	-	Title of the bizContract
from From	Date	Required	property	-	"2026-05-30T19:59:46.613Z"	-	-	Start date of the bizContract
to To	Date	Required	property	-	"2026-08-30T19:59:46.613Z"	-	-	End date of the bizContract
abstract Abstract	String	Required	property	-	null	-	-	Abstract of the bizContract
milestones Milestones	[Milestone]	Required	property	-	[]	-	-	Milestones of the bizContract
cashflows Payment Conditions	[Cashflow]	Required	property	-	[]	-	-	Payment Conditions of the bizContract
cashUnit Cash Unit	String	Required	property	-	krw	-	krw	Unit of the cashflow
content Content	Any	Required	property	-	[]	-	-	Content of the bizContract
contentFiles Content Files	[File]	Required	property	reference	[]	-	-	Files of the content
createdBy Created By	LightUser	Required	property	reference	null	-	-	Creator of the bizContract
totalValue Total Value	Int	Required	property	-	0	min 0	-	Total value of the bizContract
bizSigns Signs	[BizSign]	Required	property	-	[]	-	-	Signs of the bizContract
status Status	String	Required	property	-	active	-	activedraftfixedsigned	Status of the BizContract

BizDoc

bizDoc

BizDoc description

BizDoc

Full

15 fields

Key	Type	Required	Field Type	Relation	Default	Constraints	Enum	Description
id ID	ID	Required	property	-	null	-	-	Unique ID value
createdAt CreatedAt	Date	Required	property	-	null	-	-	Data created time
updatedAt UpdatedAt	Date	Required	property	-	null	-	-	Data updated time
removedAt RemovedAt	Date	Optional	property	-	null	-	-	Data removed time
org Organization	LightOrg	Required	property	reference	null	-	-	Organization of the bizDoc
project Project	LightProject	Optional	property	reference	null	-	-	Project of the bizDoc
type Type	String	Required	property	-	null	-	administrativedevelopmentbusinessfinanciallegalmarketingdesignoperationalother	Type of the bizDoc
title Title	String	Required	property	-	null	-	-	Title of the bizDoc
abstract Abstract	String	Required	property	-	null	-	-	Abstract of the bizDoc
files Files	[File]	Required	property	reference	[]	-	-	Files of the bizDoc
content Content	Any	Required	property	-	[]	-	-	Content of the bizDoc
contentFiles Content Files	[File]	Required	property	reference	[]	-	-	Content files of the bizDoc
createdBy Created By	LightUser	Required	property	reference	null	-	-	Created by of the bizDoc
access Access	String	Required	property	-	private	-	publicprivateonlyOwner	Access of the bizDoc
status Status	String	Required	property	-	active	-	activeexpired	Status of the BizDoc

BizInquiry

bizInquiry

BizInquiry description

BizInquiry

Full

12 fields

Key	Type	Required	Field Type	Relation	Default	Constraints	Enum	Description
id ID	ID	Required	property	-	null	-	-	Unique ID value
createdAt CreatedAt	Date	Required	property	-	null	-	-	Data created time
updatedAt UpdatedAt	Date	Required	property	-	null	-	-	Data updated time
removedAt RemovedAt	Date	Optional	property	-	null	-	-	Data removed time
companyName Company Name	String	Required	property	-	null	-	-	Company name, which is the name of the company that made the inquiry
name Name	String	Required	property	-	null	-	-	Name of the person who made the inquiry
email Email	String	Optional	property	-	null	-	-	Email of the person who made the inquiry
phone Phone	String	Required	property	-	null	-	-	Phone number of the person who made the inquiry
budget Budget	String	Required	property	-	null	-	-	Budget of the company that made the inquiry
content Content	String	Optional	property	-	null	-	-	Content of the inquiry
exampleSite Example Site	String	Optional	property	-	null	-	-	Example site of the inquiry
file File	File	Optional	property	reference	null	-	-	Upload file

BizLicense

bizLicense

BizLicense description

BizLicense

Full

14 fields

Key	Type	Required	Field Type	Relation	Default	Constraints	Enum	Description
id ID	ID	Required	property	-	null	-	-	Unique ID value
createdAt CreatedAt	Date	Required	property	-	null	-	-	Data created time
updatedAt UpdatedAt	Date	Required	property	-	null	-	-	Data updated time
removedAt RemovedAt	Date	Optional	property	-	null	-	-	Data removed time
type Type	String	Required	property	-	corporate	-	corporateindividual	Type of bizLicense
name Company Name	String	Required	property	-	null	-	-	Company name of bizLicense
auxName Aux Name	String	Optional	property	-	null	-	-	Aux name of bizLicense
ceoName Representative Name	String	Required	property	-	null	-	-	Representative name of bizLicense
licenseNo License Number	String	Required	property	-	null	-	-	License number of bizLicense
address Address	String	Required	property	-	null	-	-	Address of bizLicense
realAddress Real Address	String	Optional	property	-	null	-	-	Real address of bizLicense
sendEmails Send Emails	[String]	Required	property	-	[]	-	-	Send emails of bizLicense
org Org	LightOrg	Optional	property	reference	null	-	-	Org of bizLicense
status Status	String	Required	property	-	active	-	activeclosed	Status of the BizLicense

Board

board

Board

Full

10 fields

Key	Type	Required	Field Type	Relation	Default	Constraints	Enum	Description
id ID	ID	Required	property	-	null	-	-	Unique ID value
createdAt CreatedAt	Date	Required	property	-	null	-	-	Data created time
updatedAt UpdatedAt	Date	Required	property	-	null	-	-	Data updated time
removedAt RemovedAt	Date	Optional	property	-	null	-	-	Data removed time
name Name	String	Required	property	-	null	-	-	Name
description Description	String	Required	property	-	null	-	-	Description
categories Categories	[String]	Required	property	-	[]	-	-	Categories
policy Policy	[String]	Required	property	-	[]	-	autoApproveprivateone-onenoti.admin.discordnoti.user.emailnoti.user.phone	Policy
roles Roles	[String]	Required	property	-	[]	-	rootadminuserbusinessguest	Roles
viewStyle ViewStyle	String	Required	property	-	null	-	gallerylistboardyoutube	ViewStyle

ChatRoom

chatRoom

ChatRoom

Full

14 fields

Key	Type	Required	Field Type	Relation	Default	Constraints	Enum	Description
id ID	ID	Required	property	-	null	-	-	Unique ID value
createdAt CreatedAt	Date	Required	property	-	null	-	-	Data created time
updatedAt UpdatedAt	Date	Required	property	-	null	-	-	Data updated time
removedAt RemovedAt	Date	Optional	property	-	null	-	-	Data removed time
rootType Root Type	String	Required	property	-	user	-	-	Root Type
root Root	ID	Required	property	-	null	-	-	Root
users Users	[LightUser]	Required	resolve	reference	[]	-	-	Users
initChatRoom Init ChatRoom	ID	Required	property	-	[function]	-	-	Init ChatRoom
chats Chats	[Chat]	Required	property	-	[]	-	-	Chats
contribution Contribution	ChatContribution	Required	property	-	[function]	-	-	Contribution
roomNum Room Number	Int	Required	property	-	0	min 0	-	Room Number
reads Reads	Map<String, Date>	Required	property	-	[function]	-	-	Reads
liveUsers Live Users	[String]	Required	property	-	[]	-	-	Live Users
status Status	String	Required	property	-	active	-	activeclosed	Status of the chatRoom

Comment

comment

Comment

Full

21 fields

Key	Type	Required	Field Type	Relation	Default	Constraints	Enum	Description
id ID	ID	Required	property	-	null	-	-	Unique ID value
createdAt CreatedAt	Date	Required	property	-	null	-	-	Data created time
updatedAt UpdatedAt	Date	Required	property	-	null	-	-	Data updated time
removedAt RemovedAt	Date	Optional	property	-	null	-	-	Data removed time
rootType RootType	String	Required	property	-	null	-	-	RootType
root Root	ID	Required	property	-	null	-	-	Root
group Group	String	Optional	property	-	null	-	-	Group
parentType ParentType	String	Optional	property	-	null	-	-	ParentType
parent Parent	ID	Optional	property	-	null	-	-	Parent
type Type	String	Required	property	-	null	-	useradminanonymous	Type
user User	LightUser	Required	property	reference	null	-	-	User
name Name	String	Optional	property	-	null	-	-	Name
phone Phone	String	Optional	property	-	null	-	-	Phone
email Email	String	Optional	property	-	null	-	-	Email
content Content	String	Required	property	-	null	-	-	Content
meta Meta	Any	Optional	property	-	null	-	-	Meta
policy Policy	[String]	Required	property	-	[]	-	privatethumbnailRequirednoCommentnoSubComment	Policy
parentCreatedAt ParentCreatedAt	Date	Required	property	-	[function]	-	-	ParentCreatedAt
totalStat TotalStat	StoryStat	Required	property	-	[function]	-	-	TotalStat
status Status	String	Required	property	-	active	-	activeapproveddeniedremoved	Status of the comment
like Like	Int	Required	resolve	-	0	-	-	Like

Emoji

emoji

Emoji

Full

6 fields

Key	Type	Required	Field Type	Relation	Default	Constraints	Enum	Description
id ID	ID	Required	property	-	null	-	-	Unique ID value
createdAt CreatedAt	Date	Required	property	-	null	-	-	Data created time
updatedAt UpdatedAt	Date	Required	property	-	null	-	-	Data updated time
removedAt RemovedAt	Date	Optional	property	-	null	-	-	Data removed time
name Name	String	Required	property	-	Default Emoji	-	-	Name
file File	File	Required	property	reference	null	-	-	File

EstSheet

estSheet

Estimate Sheet description

EstSheet

Full

22 fields

Key	Type	Required	Field Type	Relation	Default	Constraints	Enum	Description
id ID	ID	Required	property	-	null	-	-	Unique ID value
createdAt CreatedAt	Date	Required	property	-	null	-	-	Data created time
updatedAt UpdatedAt	Date	Required	property	-	null	-	-	Data updated time
removedAt RemovedAt	Date	Optional	property	-	null	-	-	Data removed time
org Org	LightOrg	Required	property	reference	null	-	-	Org
project Project	LightProject	Optional	property	reference	null	-	-	Project
fromBiz Provider	LightBizLicense	Required	property	reference	null	-	-	Provider of the estimate sheet
toBiz Customer	LightBizLicense	Required	property	reference	null	-	-	Customer of the estimate sheet
type Type	String	Required	property	-	null	-	salesoftwareDevelopsoftwareManageconsultingservice	Type
title Title	String	Required	property	-	null	-	-	Title
estimates Estimates	[Estimate]	Required	property	-	[]	-	-	Estimates
cashUnit Cash Unit	String	Required	property	-	krw	-	krw	Cash Unit
note Note	String	Optional	property	-	null	-	-	Note
issueAt Issued At	Date	Required	property	-	"2026-05-30T19:59:46.613Z"	-	-	Issued At
expireAt Expire At	Date	Required	property	-	"2026-11-29T19:59:46.613Z"	-	-	Expire At
sendEmails Send Emails	[String]	Required	property	-	[]	-	-	Send Emails
bizCards Biz Cards	[LightBizCard]	Required	property	reference	[]	-	-	Biz Cards
createdBy Created By	LightUser	Required	property	reference	null	-	-	Created By
transactionAt Transaction At	Date	Required	property	-	"1970-01-01T00:00:00.000Z"	-	-	Transaction At
suppliedAt Supplied At	Date	Required	property	-	"1970-01-01T00:00:00.000Z"	-	-	Supplied At
total Total	Float	Required	property	-	0	-	-	Total
status Status	String	Required	property	-	draft	-	draftsignedexecutedexpired	Status of the EstSheet

File

file

File is a blob data that is stored in the database, such as image, document or video

File

Full

15 fields

Key	Type	Required	Field Type	Relation	Default	Constraints	Enum	Description
id ID	ID	Required	property	-	null	-	-	Unique ID value
createdAt CreatedAt	Date	Required	property	-	null	-	-	Data created time
updatedAt UpdatedAt	Date	Required	property	-	null	-	-	Data updated time
removedAt RemovedAt	Date	Optional	property	-	null	-	-	Data removed time
filename File Name	String	Required	property	-	null	-	-	Name of the file with extension
mimetype Mime Type	String	Required	property	-	null	-	-	Mime type of the file
encoding Encoding	String	Required	property	-	null	-	-	Encoding of the file
imageSize Image Size	[Int]	Required	property	-	[0,0]	-	-	Size of the image as width and height tuple in pixel
url Url	String	Optional	property	-		-	-	Url of the file
abstractData Abstract Data	String	Optional	property	-	null	-	-	Abstract blurred encoded data of image files to preview
size Size	Int	Required	property	-	0	-	-	File size in bytes
origin Origin	String	Optional	property	-	null	-	-	Origin source url of the file
lastModifiedAt Last Modified At	Date	Required	property	-	[function]	-	-	Last modified date of the file
progress Progress	Int	Optional	property	-	null	-	-	Upload progress of the file, uploading status files are used only
status Status	String	Required	property	-	uploading	-	activeuploading	Status of the file

GroupCall

groupCall

GroupCall

Full

12 fields

Key	Type	Required	Field Type	Relation	Default	Constraints	Enum	Description
id ID	ID	Required	property	-	null	-	-	Unique ID value
createdAt CreatedAt	Date	Required	property	-	null	-	-	Data created time
updatedAt UpdatedAt	Date	Required	property	-	null	-	-	Data updated time
removedAt RemovedAt	Date	Optional	property	-	null	-	-	Data removed time
type Type	String	Required	property	-	null	-	callvideo	Type
roomId Room ID	String	Required	property	-	[function]	-	-	Room ID
startAt Start At	Date	Required	property	-	[function]	-	-	Start At
endAt End At	Date	Optional	property	-	null	-	-	End At
users Users	[User]	Required	property	reference	[]	-	-	Users
totalContribution Total Contribution	CallContribution	Optional	property	-	null	-	-	Total Contribution
totalReview Total Review	ServiceReview	Optional	property	-	null	-	-	Total Review
status Status	String	Required	property	-	active	-	activeclosed	Status of the groupCall

Notification

notification

Notification is a group of informations that is sent or going to be sent to the user. It is used for the user to be notified of the event, and the events can be accumulated and summarized by groups.

Notification

Full

11 fields

Key	Type	Required	Field Type	Relation	Default	Constraints	Enum	Description
id ID	ID	Required	property	-	null	-	-	Unique ID value
createdAt CreatedAt	Date	Required	property	-	null	-	-	Data created time
updatedAt UpdatedAt	Date	Required	property	-	null	-	-	Data updated time
removedAt RemovedAt	Date	Optional	property	-	null	-	-	Data removed time
token Token	String	Optional	property	-	null	-	-	Token of the notification
title Title	String	Required	property	-	null	-	-	Title of the notification
content Content	String	Required	property	-	null	-	-	Content of the notification
field Field	String	Optional	property	-	null	-	-	Field of the notification
image Image	File	Optional	property	reference	null	-	-	Image of the notification
type Type	String	Required	property	-	token	-	topictoken	Type of the notification
level Level	String	Required	property	-	notice	-	actionRequirednoticeessentialsuggestionadvertise	Level of the notification

Org

org

Org

Full

16 fields

Key	Type	Required	Field Type	Relation	Default	Constraints	Enum	Description
id ID	ID	Required	property	-	null	-	-	Unique ID value
createdAt CreatedAt	Date	Required	property	-	null	-	-	Data created time
updatedAt UpdatedAt	Date	Required	property	-	null	-	-	Data updated time
removedAt RemovedAt	Date	Optional	property	-	null	-	-	Data removed time
name Name	String	Required	property	-	null	-	-	Name
logo Logo	File	Optional	property	reference	null	-	-	Logo
owners Owners	[LightUser]	Required	property	reference	[]	-	-	Owners
ownerInvites OwnerInvites	[LightUser]	Required	property	reference	[]	-	-	OwnerInvites
ownerInviteEmails OwnerInviteEmails	[String]	Required	property	-	[]	-	-	OwnerInviteEmails
operators Operators	[LightUser]	Required	property	reference	[]	-	-	Operators
operatorInvites OperatorInvites	[LightUser]	Required	property	reference	[]	-	-	OperatorInvites
operatorInviteEmails OperatorInviteEmails	[String]	Required	property	-	[]	-	-	OperatorInviteEmails
viewers Viewers	[LightUser]	Required	property	reference	[]	-	-	Viewers
viewerInviteEmails ViewerInviteEmails	[String]	Required	property	-	[]	-	-	ViewerInviteEmails
viewerInvites ViewerInvites	[LightUser]	Required	property	reference	[]	-	-	ViewerInvites
prevUsers PrevUsers	[ID]	Required	property	-	[]	-	-	PrevUsers

PageBlock

pageBlock

Note description

PageBlock

Full

19 fields

Key	Type	Required	Field Type	Relation	Default	Constraints	Enum	Description
id ID	ID	Required	property	-	null	-	-	Unique ID value
createdAt CreatedAt	Date	Required	property	-	null	-	-	Data created time
updatedAt UpdatedAt	Date	Required	property	-	null	-	-	Data updated time
removedAt RemovedAt	Date	Optional	property	-	null	-	-	Data removed time
rootType Root Type	String	Optional	property	-	null	-	-	Root type of the pageBlock
root Root	ID	Optional	property	-	null	-	-	Root of the pageBlock
tags Tags	[String]	Required	property	-	[]	-	-	Tags of the pageBlock
emoji Emoji	String	Optional	property	-	null	-	-	Emoji of the pageBlock title
parent Parent	ID	Optional	property	-	null	-	-	Parent of the pageBlock
parentType Parent Type	String	Optional	property	-	null	-	-	Parent type of the pageBlock
parentContentBlock Parent ContentBlock	String	Optional	property	-	null	-	-	Parent contentBlock of the pageBlock
category Category	String	Optional	property	-	null	-	-	Category of the pageBlock
user User	LightUser	Required	property	reference	null	-	-	User of the pageBlock
title Title	String	Optional	property	-	null	-	-	Title of the pageBlock
content Content	Any	Required	property	-	[]	-	-	Content of the pageBlock
thumbnails Thumbnails	[File]	Required	property	reference	[]	-	-	Thumbnails of the pageBlock
logo Logo	File	Optional	property	reference	null	-	-	Logo of the pageBlock
images Images	[File]	Required	property	reference	[]	-	-	Images of the pageBlock
depth Depth	Int	Required	property	-	0	-	-	Depth of the pageBlock

PrivFile

privFile

Private file is a server-only blob that is stored outside public asset serving.

PrivFile

Full

13 fields

Key	Type	Required	Field Type	Relation	Default	Constraints	Enum	Description
id ID	ID	Required	property	-	null	-	-	Unique ID value
createdAt CreatedAt	Date	Required	property	-	null	-	-	Data created time
updatedAt UpdatedAt	Date	Required	property	-	null	-	-	Data updated time
removedAt RemovedAt	Date	Optional	property	-	null	-	-	Data removed time
alias Alias	String	Required	property	-	null	-	-	Display alias for the private file
filename File Name	String	Optional	hidden	-	null	-	-	Name of the file with extension
mimetype Mime Type	String	Required	property	-	null	-	-	Mime type of the private file
encoding Encoding	String	Required	property	-	null	-	-	Encoding of the private file
privatePath Private Path	String	Optional	hidden	-	null	-	-	Private path of the private file
size Size	Int	Required	property	-	0	-	-	Private file size in bytes
lastModifiedAt Last Modified At	Date	Required	property	-	[function]	-	-	Last modified date of the private file
progress Progress	Int	Optional	property	-	null	-	-	Upload progress of the private file, uploading status files are used only
status Status	String	Required	property	-	uploading	-	activeuploading	Status of the private file

Project

project

Project

Full

20 fields

Key	Type	Required	Field Type	Relation	Default	Constraints	Enum	Description
id ID	ID	Required	property	-	null	-	-	Unique ID value
createdAt CreatedAt	Date	Required	property	-	null	-	-	Data created time
updatedAt UpdatedAt	Date	Required	property	-	null	-	-	Data updated time
removedAt RemovedAt	Date	Optional	property	-	null	-	-	Data removed time
org Org	LightOrg	Required	property	reference	null	-	-	Org
code Code	String	Required	property	-	[function]	-	-	Code
name Name	String	Required	property	-	null	-	-	Name
abstract Abstract	String	Optional	property	-	null	-	-	Abstract
manager Manager	LightUser	Optional	property	reference	null	-	-	Manager
members Members	[LightUser]	Required	property	reference	[]	-	-	Members
contactPhones Phones	[String]	Required	property	-	[]	-	-	ContactPhones
dependencies Dependencies	[String]	Required	property	-	[]	-	appcodebasecontractgamemintplatformsocialsharedutilframework	Dependencies
contactEmails Emails	[String]	Required	property	-	[]	-	-	ContactEmails
isPortfolio Is Portfolio	Boolean	Required	property	-	false	-	-	Is Portfolio
portfolioInfos Portfolio Infos	[PortfolioInfo]	Required	property	-	[]	-	-	Portfolio Infos
bizLicense Biz License	LightBizLicense	Optional	property	reference	null	-	-	Biz License
bizCards Biz Cards	[LightBizCard]	Required	property	reference	[]	-	-	Biz Cards
content Content	Any	Required	property	-	[]	-	-	Content
contentFiles Content Files	[File]	Required	property	reference	[]	-	-	Content files
status Status	String	Required	property	-	active	-	activedeployinghealthyunhealthy	Status of the Project

ProjectReport

projectReport

ProjectReport

Full

18 fields

Key	Type	Required	Field Type	Relation	Default	Constraints	Enum	Description
id ID	ID	Required	property	-	null	-	-	Unique ID value
createdAt CreatedAt	Date	Required	property	-	null	-	-	Data created time
updatedAt UpdatedAt	Date	Required	property	-	null	-	-	Data updated time
removedAt RemovedAt	Date	Optional	property	-	null	-	-	Data removed time
from report From	Date	Required	property	-	[function]	-	-	report From
to report To	Date	Required	property	-	[function]	-	-	report To
contentFiles content Files	[File]	Required	property	reference	[]	-	-	content Files
content content	Any	Required	property	-	[]	-	-	content
contentOnApp content On App	Any	Required	property	-	[]	-	-	content On App
contentOnFramework content On Framework	Any	Required	property	-	[]	-	-	content On Framework
title title	String	Required	property	-	null	-	-	title
project project	LightProject	Required	property	reference	null	-	-	project
user manager	LightUser	Required	property	reference	null	-	-	manager
totalTickets Total Tickets	[LightTicket]	Required	property	reference	[]	-	-	total Tickets
summary summary	String	Optional	property	-		-	-	summary
totalTicketNum total Ticket Num	Int	Required	property	-	0	-	-	total Ticket Num
access access	String	Required	property	-	private	-	publicprivateonlyOwner	access
status status	String	Required	property	-	active	-	activepublished	status

Report

report

Report

Full

16 fields

Key	Type	Required	Field Type	Relation	Default	Constraints	Enum	Description
id ID	ID	Required	property	-	null	-	-	Unique ID value
createdAt CreatedAt	Date	Required	property	-	null	-	-	Data created time
updatedAt UpdatedAt	Date	Required	property	-	null	-	-	Data updated time
removedAt RemovedAt	Date	Optional	property	-	null	-	-	Data removed time
root Root	ID	Optional	property	-	null	-	-	Root
type Type	String	Required	property	-	null	-	-	Type
target Target	ID	Optional	property	-	null	-	-	Target
targetUser TargetUser	LightUser	Required	property	reference	null	-	-	TargetUser
from From	LightUser	Required	property	reference	null	-	-	From
title Title	String	Required	property	-	null	maxlength 200	-	Title
content Content	String	Required	property	-	null	maxlength 10000	-	Content
files Files	[File]	Required	property	reference	[]	-	-	Files
replyFrom ReplyFrom	LightAdmin	Optional	property	reference	null	-	-	ReplyFrom
replyContent ReplyContent	String	Optional	property	-	null	maxlength 10000	-	ReplyContent
replyAt ReplyAt	Date	Required	property	-	[function]	-	-	ReplyAt
status Status	String	Required	property	-	active	-	activeinProgressresolved	Status of the report

ServiceDesk

serviceDesk

ServiceDesk

Full

11 fields

Key	Type	Required	Field Type	Relation	Default	Constraints	Enum	Description
id ID	ID	Required	property	-	null	-	-	Unique ID value
createdAt CreatedAt	Date	Required	property	-	null	-	-	Data created time
updatedAt UpdatedAt	Date	Required	property	-	null	-	-	Data updated time
removedAt RemovedAt	Date	Optional	property	-	null	-	-	Data removed time
user User	LightUser	Required	property	reference	null	-	-	User
chats Chats	[Chat]	Required	property	-	[]	-	-	Chats
admin Admin	LightAdmin	Optional	property	reference	null	-	-	Admin
files Files	[File]	Required	property	reference	[]	-	-	Files
emojis Emojis	[LightEmoji]	Required	property	reference	[]	-	-	Emojis
review Review	ServiceReview	Optional	property	-	null	-	-	Review
status Status	String	Required	property	-	active	-	activeresolved	Status of the serviceDesk

Setting

setting

Setting is a system setting that is controll and manage the metrics of the system and the service.

Setting

Full

5 fields

Key	Type	Required	Field Type	Relation	Default	Constraints	Enum	Description
id ID	ID	Required	property	-	null	-	-	Unique ID value
createdAt CreatedAt	Date	Required	property	-	null	-	-	Data created time
updatedAt UpdatedAt	Date	Required	property	-	null	-	-	Data updated time
removedAt RemovedAt	Date	Optional	property	-	null	-	-	Data removed time
resignupDays Re-signup Days	Int	Required	property	-	0	-	-	The number of days to allow re-signup

Story

story

Story

Full

22 fields

Key	Type	Required	Field Type	Relation	Default	Constraints	Enum	Description
id ID	ID	Required	property	-	null	-	-	Unique ID value
createdAt CreatedAt	Date	Required	property	-	null	-	-	Data created time
updatedAt UpdatedAt	Date	Required	property	-	null	-	-	Data updated time
removedAt RemovedAt	Date	Optional	property	-	null	-	-	Data removed time
root Root	ID	Required	property	-	null	-	-	Root
rootType RootType	String	Required	property	-	board	-	-	RootType
parent Parent	ID	Optional	property	-	null	-	-	Parent
parentType ParentType	String	Optional	property	-	null	-	-	ParentType
category Category	String	Optional	property	-	null	-	-	Category
type Type	String	Required	property	-	null	-	useradminanonymous	Type
user User	LightUser	Optional	property	reference	null	-	-	User
title Title	String	Required	property	-	null	-	-	Title
content Content	Any	Required	property	-	[]	-	-	Content
thumbnails Thumbnails	[File]	Required	property	reference	[]	-	-	Thumbnails
logo Logo	File	Optional	property	reference	null	-	-	Logo
policy Policy	[String]	Required	property	-	[]	-	privatethumbnailRequirednoCommentnoSubComment	Policy
images Images	[File]	Required	property	reference	[]	-	-	Images
parentCreatedAt ParentCreatedAt	Date	Required	property	-	[function]	-	-	ParentCreatedAt
totalStat TotalStat	StoryStat	Required	property	-	[function]	-	-	TotalStat
status Status	String	Required	property	-	active	-	activeapproveddenied	Status of the story
view View	Int	Required	resolve	-	0	-	-	View
like Like	Int	Required	resolve	-	0	-	-	Like

Summary

summary

Summary is a group of system and service metrics that is used for the system to be monitored and managed.

Summary

Full

36 fields

Key	Type	Required	Field Type	Relation	Default	Constraints	Enum	Description
id ID	ID	Required	property	-	null	-	-	Unique ID value
createdAt CreatedAt	Date	Required	property	-	null	-	-	Data created time
updatedAt UpdatedAt	Date	Required	property	-	null	-	-	Data updated time
removedAt RemovedAt	Date	Optional	property	-	null	-	-	Data removed time
type Type	String	Required	property	-	non-periodic	-	non-periodicactivehourlydailyweeklymonthly	Type of summary, e.g. periodic, non-periodic...
at At	Date	Required	property	-	[function]	-	-	The time when the summary is created
status Status	String	Required	property	-	archived	-	activearchived	Status of the summary
prepareUser Prepare User	Int	Required	property	-	0	-	-	Number of users with preparation
activeUser Active User	Int	Required	property	-	0	-	-	Number of active users
dormantUser Dormant User	Int	Required	property	-	0	-	-	Number of dormant users
restrictedUser Restricted User	Int	Required	property	-	0	-	-	Number of users with restrictions
hau HAU	Int	Required	property	-	0	-	-	Hourly Active User
dau DAU	Int	Required	property	-	0	-	-	Daily Active User
wau WAU	Int	Required	property	-	0	-	-	Weekly Active User
mau MAU	Int	Required	property	-	0	-	-	Monthly Active User
haActionLog HA ActionLog	Int	Required	property	-	0	min 0	-	HA ActionLog
daActionLog DA ActionLog	Int	Required	property	-	0	min 0	-	DA ActionLog
waActionLog WA ActionLog	Int	Required	property	-	0	min 0	-	WA ActionLog
maActionLog MA ActionLog	Int	Required	property	-	0	min 0	-	MA ActionLog
activeComment Active Comment	Int	Required	property	-	0	min 0	-	Active Comment
approvedComment Approved Comment	Int	Required	property	-	0	min 0	-	Approved Comment
deniedComment Denied Comment	Int	Required	property	-	0	min 0	-	Denied Comment
haComment Hourly Comment	Int	Required	property	-	0	min 0	-	Hourly active comment
daComment Daily Comment	Int	Required	property	-	0	min 0	-	Daily active comment
waComment WA Comment	Int	Required	property	-	0	min 0	-	Weekly active comment
maComment MA Comment	Int	Required	property	-	0	min 0	-	Monthly active comment
activeReport ActiveReport	Int	Required	property	-	0	min 0	-	ActiveReport
inProgressReport InProgressReport	Int	Required	property	-	0	min 0	-	InProgressReport
resolvedReport ResolvedReport	Int	Required	property	-	0	min 0	-	ResolvedReport
activeStory Active Story	Int	Required	property	-	0	min 0	-	Active Story
approvedStory Approved Story	Int	Required	property	-	0	min 0	-	Approved Story
deniedStory Denied Story	Int	Required	property	-	0	min 0	-	Denied Story
haStory Hourly Story	Int	Required	property	-	0	min 0	-	Hourly Story
daStory Daily Story	Int	Required	property	-	0	min 0	-	Daily Story
waStory Weekly Story	Int	Required	property	-	0	min 0	-	Weekly Story
maStory Monthly Story	Int	Required	property	-	0	min 0	-	Monthly Story

Ticket

ticket

Ticket

Full

15 fields

Key	Type	Required	Field Type	Relation	Default	Constraints	Enum	Description
id ID	ID	Required	property	-	null	-	-	Unique ID value
createdAt CreatedAt	Date	Required	property	-	null	-	-	Data created time
updatedAt UpdatedAt	Date	Required	property	-	null	-	-	Data updated time
removedAt RemovedAt	Date	Optional	property	-	null	-	-	Data removed time
project Project	LightProject	Required	property	reference	null	-	-	Project
title Title	String	Required	property	-	null	-	-	Title
content Content	Any	Required	property	-	[]	-	-	Content
contentFiles ContentFiles	[File]	Required	property	reference	[]	-	-	ContentFiles
user ticket writer	LightUser	Required	property	reference	null	-	-	ticket writer
type Type	String	Required	property	-	shared	-	appcodebasecontractgamemintplatformsocialsharedutilframework	Type
status Status	String	Required	property	-	active	-	activerejectedopenedinProgressdonereviewingfeedbackcompletedarchived	Status of the Ticket
due Due	Date	Required	property	-	[function]	-	-	Due
progressBy ProgressBy	LightUser	Optional	property	reference	null	-	-	ProgressBy
reviewBy ReviewBy	LightUser	Optional	property	reference	null	-	-	ReviewBy
histories Histories	[History]	Required	property	-	[]	-	-	Histories

User

user

User is an public information of the user who uses the service. It can be displayed to other users.

User

Full

33 fields

Key	Type	Required	Field Type	Relation	Default	Constraints	Enum	Description
id ID	ID	Required	property	-	null	-	-	Unique ID value
createdAt CreatedAt	Date	Required	property	-	null	-	-	Data created time
updatedAt UpdatedAt	Date	Required	property	-	null	-	-	Data updated time
removedAt RemovedAt	Date	Optional	property	-	null	-	-	Data removed time
nickname Nickname	String	Optional	property	-		maxlength 12	-	Nickname of the user that is displayed to other users
image Image	File	Optional	property	reference	null	-	-	Profile image of the user
images Images	[File]	Required	property	reference	[]	-	-	Profile images of the user
appliedImages Applied Images	[File]	Required	property	reference	[]	-	-	Applied images of the user
name Name	String	Optional	hiddenselect:false	-	null	-	-	Name of the user
agreePolicies Agree Policies	[String]	Optional	hiddenselect:false	-	[]	-	-	Agreed policies of the user
discord Discord	Any	Optional	hiddenselect:false	-	{}	-	-	Discord information of the user
accountId Account ID	String	Optional	hiddenselect:false	-	null	-	-	Account ID of the user
password Password	String	Optional	hiddenselect:false	-	null	-	-	Password of the user
phone Phone	String	Optional	hiddenselect:false	-	null	-	-	Phone number of the user
notiInfo Noti Info	NotiInfo	Optional	hiddenselect:false	-	null	-	-	Notification information of the user
imageNum Image Number	Int	Optional	hiddenselect:false	-	0	-	-	Number of images of the user
encourageInfo Encourage Info	EncourageInfo	Optional	hiddenselect:false	-	[function]	-	-	Encourage information of the user
restrictInfo Restrict Info	RestrictInfo	Optional	hiddenselect:false	-	null	-	-	Restrict information of the user
leaveInfo Leave Info	LeaveInfo	Optional	hiddenselect:false	-	null	-	-	Leave information of the user
verifies Verifies	[String]	Required	property	-	[]	-	naverkakaogithubgoogleapplefacebookwalletpasswordphoneemail	Verification information of the user
roles Roles	[String]	Required	property	-	["user"]	-	rootadminuserbusinessguest	Authorized roles of the user
playing Playing	[String]	Required	property	-	[]	-	-	Services that the user is playing
isOnline Is Online	Boolean	Required	property	-	true	-	-	Online status of the user
lastLoginAt Last Login At	Date	Required	property	-	[function]	-	-	Latest login time of the user
joinAt Join At	Date	Optional	property	-	null	-	-	Join date of the user
profileStatus Profile Status	String	Required	property	-	prepare	-	activeprepareappliedapprovedreappliedfeaturedreservedrejected	Profile approval status of the user
badgeCount Badge Count	Int	Required	property	-	0	-	-	Badge count of the user
status Status	String	Required	property	-	prepare	-	prepareactivedormantrestricted	Status of the user
interests Interests	[String]	Required	property	-	[]	-	festivalcatdancetravelinstagramforeignLanguageexhibitiongardeningsurfingyogajoggingphotographyhikingbornInThe90sboardGameschallengeSeekerreadingcookingwalkingtrivianetflixgourmetcampingvrexercisemusicecoFriendlycrossFitwinemoviekaraokeanimationdiyworldTourwritingeSportsbrunchveganbicycleathleteprefersFriendConversationsartpicniccraftBeerbreadmuseumpetmulticulturalcomedydisneyswimmingstartupchristianityvolunteeringdogdrivedrinkfishingoutdoorActivitycafeHoppingsportsblognaturepoliticsneighborhoodWalkclimbingperformancecoffeecarfashionolympicszodiacvlogsnackbarpartygolfgamepodcastneighborhoodFriendteapcCafefoodTourtheaterchattingForFunshoppingorigamiisfjintjinfjinfpenfpesfpistpisfpistjesfjestpestjentjentpenfjintpselfImprovementstockInvestmentcryptocurrencycatholicismbuddhismatheismbaseballsoccerbasketballskiingfreeDivingscubaDivingpuppyfinancialPlanningaquariumleagueOfLegendspubgamongUs	Interests
profileMessage Profile Message	String	Optional	property	-		-	-	Profile Message
defaultMessage Default Message	String	Optional	property	-		-	-	Default Message
dateOfBirth Date of Birth	Date	Required	property	-	"0000-01-01T00:00:00.000Z"	-	-	Date of Birth
gender Gender	String	Required	property	-	male	-	malefemale	Gender

Scalar Models

AccessLog

accessLog

Access log information

Key	Type	Required	Field Type	Relation	Default	Constraints	Enum	Description
period Period	Int	Required	property	-	0	-	-	Time period
countryCode Country Code	String	Optional	property	-	null	-	-	ISO country code
countryName Country Name	String	Optional	property	-	null	-	-	Name of the country
city City	String	Optional	property	-	null	-	-	City name
postal Postal	Int	Optional	property	-	null	-	-	Postal code
location Location	Coordinate	Optional	property	-	null	-	-	Geographic location
ipv4 IPv4	String	Optional	property	-	null	-	-	IPv4 address
state State	String	Optional	property	-	null	-	-	State or province
osName OS Name	String	Optional	property	-	null	-	-	Operating system name
osVersion OS Version	String	Optional	property	-	null	-	-	Operating system version
browserName Browser Name	String	Optional	property	-	null	-	-	Web browser name
browserVersion Browser Version	String	Optional	property	-	null	-	-	Web browser version
mobileModel Mobile Model	String	Optional	property	-	null	-	-	Mobile device model
mobileVendor Mobile Vendor	String	Optional	property	-	null	-	-	Mobile device vendor
deviceType Device Type	String	Optional	property	-	null	-	-	Type of device
at At	Date	Required	property	-	[function]	-	-	Access time

AccessStat

accessStat

Access statistics information

Key	Type	Required	Field Type	Relation	Constraints	Enum	Description
request Request	Int	Required	property	-	-	-	Number of requests
device Device	Int	Required	property	-	-	-	Number of devices
ip IP	Int	Required	property	-	-	-	Number of unique IPs
country Country	Int	Required	property	-	-	-	Number of countries

AccessToken

accessToken

Access token for authentication

Key	Type	Required	Field Type	Relation	Default	Constraints	Enum	Description
jwt JWT	String	Required	property	-	null	-	-	JSON Web Token
refreshToken Refresh Token	String	Optional	property	-	null	-	-	Refresh token for token renewal
expiresAt Expires At	Date	Optional	property	-	null	-	-	Access token expiration time

BizSign

bizSign

BizSign

Key	Type	Required	Field Type	Relation	Default	Constraints	Enum	Description
bizLicense BizLicense	ID	Required	property	-	null	-	-	BizLicense of BizSign
user User	ID	Optional	property	-	null	-	-	User of BizSign
sign Sign	String	Required	property	-	null	-	-	Sign of BizSign
at At	Date	Required	property	-	"2026-05-30T19:59:46.606Z"	-	-	At of BizSign

CallContribution

callContribution

Call Contribution

Key	Type	Required	Field Type	Relation	Default	Constraints	Enum	Description
speakTime Speak Time	Int	Required	property	-	0	min 0	-	Speak Time
callTime Call Time	Int	Required	property	-	0	min 0	-	Call Time

Cashflow

cashflow

Cashflow

Key	Type	Required	Field Type	Relation	Default	Constraints	Enum	Description
name Name	String	Required	property	-	null	-	-	Name of Cashflow
value Value	Float	Required	property	-	0	min 0	-	Value of Cashflow
at At	Date	Required	property	-	"2026-05-30T19:59:46.612Z"	-	-	At of Cashflow

Chat

chat

Chat

Key	Type	Required	Field Type	Relation	Default	Constraints	Enum	Description
user User	ID	Required	property	-	null	-	-	User
type Type	String	Required	property	-	text	-	textimageemojienterexit	Type
images Images	[File]	Required	property	reference	[]	-	-	Images
emoji Emoji	ID	Optional	property	-	null	-	-	Emoji
text Text	String	Optional	property	-	null	-	-	Text
at At	Date	Required	property	-	[function]	-	-	At

ChatContribution

chatContribution

Chat Contribution

Key	Type	Required	Field Type	Relation	Constraints	Enum	Description
count Count	Int	Required	property	-	min 0	-	Count
size Size	Int	Required	property	-	min 0	-	Size
totalCount Total Count	Int	Required	property	-	min 0	-	Total Count
totalSize Total Size	Int	Required	property	-	min 0	-	Total Size

Coordinate

coordinate

Geographic coordinate information

Key	Type	Required	Field Type	Relation	Default	Constraints	Enum	Description
type Type	String	Required	property	-	Point	-	Point	Coordinate type
coordinates Coordinates	[Float]	Required	property	-	[0,0]	-	-	Longitude and latitude values
altitude Altitude	Float	Required	property	-	0	-	-	Altitude in meters

EncourageInfo

encourageInfo

Encourage Info

Key	Type	Required	Field Type	Relation	Default	Constraints	Enum	Description
journey Journey	String	Required	property	-	welcome	-	welcomewaitingfirstJoinjoinedleavingleavedreturningreturned	Journey
journeyAt Journey At	Date	Required	property	-	[function]	-	-	Journey At
inquiry Inquiry	String	Required	property	-	welcome	-	welcomepayablewaitPaypaidmorePayablewaitMorePayinquiredconcernedconcernedPayableconcernedWaitPayashedvipkicked	Inquiry
inquiryAt Inquiry At	Date	Required	property	-	[function]	-	-	Inquiry At

Estimate

estimate

Estimate

Key	Type	Required	Field Type	Relation	Default	Constraints	Enum	Description
name Name	String	Required	property	-	null	-	-	Name of Estimate
value Value	Float	Required	property	-	0	min 0	-	Value of Estimate
num Num	Int	Required	property	-	1	min 1	-	Num of Estimate
unit Unit	String	Optional	property	-	null	-	-	Unit of Estimate
note Note	String	Optional	property	-	null	-	-	Note of Estimate

ExternalLink

externalLink

External Link

Key	Type	Required	Field Type	Relation	Default	Constraints	Enum	Description
type Type	String	Required	property	-	null	-	websitetwitterdiscordtelegraminstagramfacebookyoutubegithubmediumlinkedinreddittwitchvimeoweibowikipediaappemailother	Type
url URL	String	Required	property	-	null	-	-	URL

FileMeta

fileMeta

File Meta

Key	Type	Required	Field Type	Relation	Default	Constraints	Enum	Description
fileId File ID	ID	Optional	property	-	null	-	-	File ID
lastModifiedAt Last Modified At	Date	Required	property	-	null	-	-	Last Modified At
size Size	Int	Required	property	-	null	-	-	Size

History

history

History

Key	Type	Required	Field Type	Relation	Default	Constraints	Enum	Description
user User	LightUser	Optional	property	reference	null	-	-	User
action Action	String	Required	property	-	null	-	rejectopenprogressdonefeedbackreviewcompleteactivatearchive	Action
content Content	Any	Required	property	-	[]	-	-	Content
contentHtml ContentHtml	String	Optional	property	-	null	-	-	ContentHtml
at At	Date	Required	property	-	"2026-05-30T19:59:46.612Z"	-	-	At

InviteRequest

inviteRequest

Invite Request

Key	Type	Required	Field Type	Relation	Default	Constraints	Enum	Description
orgId Organization ID	ID	Required	property	-	null	-	-	Organization ID
as As	String	Required	property	-	null	-	-	As
inviterId Inviter ID	ID	Required	property	-	null	-	-	Inviter ID
inviterNickname Inviter Nickname	String	Required	property	-	null	-	-	Inviter Nickname
inviteeId Invitee ID	ID	Optional	property	-	null	-	-	Invitee ID
inviteeEmail Invitee Email	String	Required	property	-	null	-	-	Invitee Email
until Until	Date	Optional	property	-	null	-	-	Until

LeaveInfo

leaveInfo

Leave Info

Key	Type	Required	Field Type	Relation	Default	Constraints	Enum	Description
type Type	String	Required	property	-	noReply	-	noReplycomebackunsatisfiedother	Type
reason Reason	String	Optional	property	-	null	-	-	Reason
satisfaction Satisfaction	Int	Optional	property	-	null	min 1max 5	-	Satisfaction
voc VOC	String	Optional	property	-	null	-	-	VOC
at At	Date	Required	property	-	[function]	-	-	At

Milestone

milestone

Milestone

Key	Type	Required	Field Type	Relation	Default	Constraints	Enum	Description
goal Goal	String	Required	property	-	null	-	-	Goal of Milestone
output Output	String	Required	property	-	null	-	-	Output of Milestone
at At	Date	Required	property	-	"2026-05-30T19:59:46.606Z"	-	-	At of Milestone

NotiInfo

notiInfo

Noti Info

Key	Type	Required	Field Type	Relation	Default	Constraints	Enum	Description
setting Setting	String	Required	property	-	normal	-	disagreefewernormalblock	Setting
pauseUntil Pause Until	Date	Required	property	-	[function]	-	-	Pause Until
deviceTokens Device Tokens	[String]	Required	property	-	[]	-	-	Device Tokens

PortfolioInfo

portfolioInfo

PortfolioInfo

Key	Type	Required	Field Type	Relation	Default	Constraints	Enum	Description
lang Lang	String	Required	property	-	ko	-	koen	Lang
title Title	String	Required	property	-	null	-	-	Title
desc Desc	String	Required	property	-	null	-	-	Desc
hoverTitle HoverTitle	String	Required	property	-	null	-	-	HoverTitle
hoverDesc HoverDesc	String	Required	property	-	null	-	-	HoverDesc
thumbnail Thumbnail	File	Required	property	reference	null	-	-	Thumbnail

RestrictInfo

restrictInfo

Restrict Info

Key	Type	Required	Field Type	Relation	Default	Constraints	Enum	Description
until Until	Date	Required	property	-	null	-	-	Until
reason Reason	String	Required	property	-	null	-	-	Reason

SearchResult

searchResult

Search result information

Key	Type	Required	Field Type	Relation	Default	Constraints	Enum	Description
docs Documents	Any	Required	property	-	[]	-	-	Search result documents
skip Skip	Int	Required	property	-	0	-	-	Number of results skipped
limit Limit	Int	Required	property	-	20	-	-	Maximum number of results
sort Sort	String	Required	property	-	notImplemented	-	-	Sort order
total Total	Int	Required	property	-	0	-	-	Total number of results

ServiceReview

serviceReview

Service Review

Key	Type	Required	Field Type	Relation	Default	Constraints	Enum	Description
score Score	Int	Required	property	-	0	min 0	-	Score
comment Comment	String	Optional	property	-	null	-	-	Comment

StoryStat

storyStat

Statistic of Story

Key	Type	Required	Field Type	Relation	Constraints	Enum	Description
views Views	Int	Required	property	-	min 0	-	Views
likes Likes	Int	Required	property	-	min 0	-	Likes
unlikes Unlikes	Int	Required	property	-	min 0	-	Unlikes
comments Comments	Int	Required	property	-	min 0	-	Comments

Enums

Key	Ref Name	Type	Used By
adminRole	adminRole	String	admin.rolesadmin.rolesadmin.roles
bannerStatus	bannerStatus	String	banner.statusbanner.statusbanner.status
bannerTarget	bannerTarget	String	banner.targetbanner.targetbanner.targetbanner.target
bizAccess	bizAccess	String	bizDoc.accessbizDoc.accessbizDoc.accessprojectReport.accessprojectReport.access
bizAccountType	bizAccountType	String	bizAccount.typebizAccount.typebizAccount.type
bizCardStatus	bizCardStatus	String	bizCard.statusbizCard.statusbizCard.status
bizContractStatus	bizContractStatus	String	bizContract.statusbizContract.statusbizContract.status
bizDocStatus	bizDocStatus	String	bizDoc.statusbizDoc.statusbizDoc.status
bizDocType	bizDocType	String	bizDoc.typebizDoc.typebizDoc.typebizDoc.type
bizLicenseStatus	bizLicenseStatus	String	bizLicense.statusbizLicense.statusbizLicense.status
bizLicenseType	bizLicenseType	String	bizLicense.typebizLicense.typebizLicense.typebizLicense.type
bizType	bizType	String	bizContract.typebizContract.typebizContract.typebizContract.typeestSheet.typeestSheet.typeestSheet.typeestSheet.type
boardPolicy	boardPolicy	String	board.policyboard.policyboard.policyboard.policy
boardViewStyle	boardViewStyle	String	board.viewStyleboard.viewStyleboard.viewStyleboard.viewStyle
cashUnit	cashUnit	String	bizContract.cashUnitbizContract.cashUnitbizContract.cashUnitbizContract.cashUnitestSheet.cashUnitestSheet.cashUnitestSheet.cashUnitestSheet.cashUnit
chatRoomStatus	chatRoomStatus	String	chatRoom.statuschatRoom.statuschatRoom.status
chatType	chatType	String	chat.type
commentStatus	commentStatus	String	comment.statuscomment.statuscomment.status
coordinateType	coordinateType	String	coordinate.type
creatorType	creatorType	String	comment.typecomment.typecomment.typestory.typestory.typestory.typestory.type
estSheetStatus	estSheetStatus	String	estSheet.statusestSheet.statusestSheet.status
fileStatus	fileStatus	String	file.statusfile.statusfile.statusprivFile.statusprivFile.statusprivFile.status
gender	gender	String	user.genderuser.gender
groupCallStatus	groupCallStatus	String	groupCall.statusgroupCall.statusgroupCall.status
groupCallType	groupCallType	String	groupCall.typegroupCall.typegroupCall.type
historyType	historyType	String	history.action
inquiry	inquiry	String	encourageInfo.inquiry
interest	interest	String	user.interestsuser.interestsuser.interests
journey	journey	String	encourageInfo.journey
language	language	String	-
leaveType	leaveType	String	leaveInfo.type
linkType	linkType	String	externalLink.type
notificationType	notificationType	String	notification.typenotification.typenotification.typenotification.type
notiLevel	notiLevel	String	notification.levelnotification.levelnotification.levelnotification.level
notiSetting	notiSetting	String	notiInfo.setting
periodType	periodType	String	summary.typesummary.typesummary.type
portfolioLang	portfolioLang	String	portfolioInfo.lang
profileStatus	profileStatus	String	user.profileStatususer.profileStatususer.profileStatus
projectReportStatus	projectReportStatus	String	projectReport.statusprojectReport.statusprojectReport.status
projectStatus	projectStatus	String	project.statusproject.statusproject.status
reportStatus	reportStatus	String	report.statusreport.statusreport.status
responsive	responsive	String	-
serviceDeskStatus	serviceDeskStatus	String	serviceDesk.statusserviceDesk.statusserviceDesk.status
ssoType	ssoType	String	-
storyPolicy	storyPolicy	String	comment.policycomment.policycomment.policystory.policystory.policystory.policystory.policy
storyStatus	storyStatus	String	story.statusstory.statusstory.status
summaryStatus	summaryStatus	String	summary.statussummary.status
ticketStatus	ticketStatus	String	ticket.statusticket.statusticket.status
ticketType	ticketType	String	project.dependenciesproject.dependenciesproject.dependenciesproject.dependenciesticket.typeticket.typeticket.typeticket.type
userRole	userRole	String	board.rolesboard.rolesboard.rolesboard.rolesuser.rolesuser.rolesuser.roles
userStatus	userStatus	String	user.statususer.statususer.status
verify	verify	String	user.verifiesuser.verifies