Skip to main content

Member

Stored in the members collection. createdAt and updatedAt are maintained automatically.

Returned by DELETE /member, GET /member, POST /member, PUT /member/:id, PUT /member/block/:id, POST /member/bulk and 7 more.

FieldTypeNotes
emailstringrequired
userObjectId -> User
statusstringdefault invited · one of invited, accepted, rejected, blocked, owner, deleted, expired
expiresAtdate
reasonstring
blockedByObjectId -> Member
companyObjectId -> Company
roleObjectId -> Role
onboardedbooleandefault true
aiOnboardedbooleandefault true
metaData.pagination.columnsobject[]default []
metaData.pagination.columns.routestring
metaData.pagination.columns.currentViewstring
metaData.pagination.columns.currentViewNamestring
metaData.pagination.columns.totalViewsnumber
metaData.pagination.columns.typestring
metaData.pagination.columns.groupByKeystring
metaData.pagination.columns.fieldsmixed[]default []
metaData.pagination.columns.columnSettingsobjectdefault {}
metaData.pagination.columns.columnSettings.pinnedmixed[]default []
metaData.pagination.columns.columnSettings.frozenmixed[]default []
metaData.pagination.columns.columnSettings.hiddenmixed[]default []
metaData.pagination.columns.columnSettings.ascendinganydefault false
metaData.pagination.columns.columnSettings.descendinganydefault false
metaData.pagination.columns.nnumber
metaData.pagination.columns.savedFilterConfigsobject[]default []
metaData.pagination.columns.savedFilterConfigs.namestring
metaData.pagination.columns.savedFilterConfigs.idstring
metaData.pagination.columns.savedFilterConfigs.normalFiltersanydefault []
metaData.pagination.columns.savedFilterConfigs.advancedFiltersanydefault {}
metaData.pagination.columns.viewsobject[]default []
metaData.pagination.columns.views.idstring
metaData.pagination.columns.views.namestring
metaData.pagination.columns.views.typestring
metaData.pagination.columns.views.groupByKeystring
metaData.pagination.columns.views.fieldsmixed[]default []
metaData.pagination.columns.views.columnSettingsobjectdefault {}
metaData.pagination.columns.views.columnSettings.pinnedmixed[]default []
metaData.pagination.columns.views.columnSettings.frozenmixed[]default []
metaData.pagination.columns.views.columnSettings.hiddenmixed[]default []
metaData.pagination.columns.views.columnSettings.ascendinganydefault false
metaData.pagination.columns.views.columnSettings.descendinganydefault false
metaData.pagination.columns.views.nnumber
metaData.UI.layoutstringdefault md · one of sm, md, lg, xl
metaData.UI.darkModebooleandefault false
joinedDatedate
lastActiveAtdate
customRoleNamestring
permission.custom-fieldobject
permission.custom-field.GETbooleandefault false
permission.custom-field.POSTbooleandefault false
permission.custom-field.PUTbooleandefault false
permission.custom-field.DELETEbooleandefault false
permission.custom-sectionobject
permission.custom-section.GETbooleandefault false
permission.custom-section.POSTbooleandefault false
permission.custom-section.PUTbooleandefault false
permission.custom-section.DELETEbooleandefault false
permission.appsobject
permission.apps.GETbooleandefault false
permission.apps.POSTbooleandefault false
permission.apps.PUTbooleandefault false
permission.apps.DELETEbooleandefault false
permission.contactobject
permission.contact.GETbooleandefault false
permission.contact.POSTbooleandefault false
permission.contact.PUTbooleandefault false
permission.contact.DELETEbooleandefault false
permission.contact-categoryobject
permission.contact-category.GETbooleandefault false
permission.contact-category.POSTbooleandefault false
permission.contact-category.PUTbooleandefault false
permission.contact-category.DELETEbooleandefault false
permission.leadobject
permission.lead.GETbooleandefault false
permission.lead.POSTbooleandefault false
permission.lead.PUTbooleandefault false
permission.lead.DELETEbooleandefault false
permission.lead-activityobject
permission.lead-activity.GETbooleandefault false
permission.lead-activity.POSTbooleandefault false
permission.lead-activity.PUTbooleandefault false
permission.lead-activity.DELETEbooleandefault false
permission.templateobject
permission.template.GETbooleandefault false
permission.template.POSTbooleandefault false
permission.template.PUTbooleandefault false
permission.template.DELETEbooleandefault false
permission.campaignobject
permission.campaign.GETbooleandefault false
permission.campaign.POSTbooleandefault false
permission.campaign.PUTbooleandefault false
permission.campaign.DELETEbooleandefault false
permission.whatsappobject
permission.whatsapp.GETbooleandefault false
permission.whatsapp.POSTbooleandefault false
permission.whatsapp.PUTbooleandefault false
permission.whatsapp.DELETEbooleandefault false
permission.reportobject
permission.report.GETbooleandefault false
permission.report.POSTbooleandefault false
permission.report.PUTbooleandefault false
permission.report.DELETEbooleandefault false
permission.companyobject
permission.company.GETbooleandefault false
permission.company.POSTbooleandefault false
permission.company.PUTbooleandefault false
permission.company.DELETEbooleandefault false
permission.memberobject
permission.member.GETbooleandefault false
permission.member.POSTbooleandefault false
permission.member.PUTbooleandefault false
permission.member.DELETEbooleandefault false
permission.roleobject
permission.role.GETbooleandefault false
permission.role.POSTbooleandefault false
permission.role.PUTbooleandefault false
permission.role.DELETEbooleandefault false
permission.segmentobject
permission.segment.GETbooleandefault false
permission.segment.POSTbooleandefault false
permission.segment.PUTbooleandefault false
permission.segment.DELETEbooleandefault false
permission.fileobject
permission.file.GETbooleandefault false
permission.file.POSTbooleandefault false
permission.file.PUTbooleandefault false
permission.file.DELETEbooleandefault false
permission.planobject
permission.plan.GETbooleandefault false
permission.plan.POSTbooleandefault false
permission.plan.PUTbooleandefault false
permission.plan.DELETEbooleandefault false
permission.settingsobject
permission.settings.GETbooleandefault false
permission.settings.POSTbooleandefault false
permission.settings.PUTbooleandefault false
permission.settings.DELETEbooleandefault false
permission.product-serviceobject
permission.product-service.GETbooleandefault false
permission.product-service.POSTbooleandefault false
permission.product-service.PUTbooleandefault false
permission.product-service.DELETEbooleandefault false
permission.tagobject
permission.tag.GETbooleandefault false
permission.tag.POSTbooleandefault false
permission.tag.PUTbooleandefault false
permission.tag.DELETEbooleandefault false
permission.logsobject
permission.logs.GETbooleandefault false
permission.logs.POSTbooleandefault false
permission.logs.PUTbooleandefault false
permission.logs.DELETEbooleandefault false
permission.teamobject
permission.team.GETbooleandefault false
permission.team.POSTbooleandefault false
permission.team.PUTbooleandefault false
permission.team.DELETEbooleandefault false
permission.apiobject
permission.api.GETbooleandefault false
permission.api.POSTbooleandefault false
permission.api.PUTbooleandefault false
permission.api.DELETEbooleandefault false
permission.meetingobject
permission.meeting.GETbooleandefault false
permission.meeting.POSTbooleandefault false
permission.meeting.PUTbooleandefault false
permission.meeting.DELETEbooleandefault false
permission.zoomobject
permission.zoom.GETbooleandefault false
permission.zoom.POSTbooleandefault false
permission.zoom.PUTbooleandefault false
permission.zoom.DELETEbooleandefault false
permission.my-zoomobject
permission.my-zoom.GETbooleandefault false
permission.my-zoom.POSTbooleandefault false
permission.my-zoom.PUTbooleandefault false
permission.my-zoom.DELETEbooleandefault false
permission.google-calendarobject
permission.google-calendar.GETbooleandefault false
permission.google-calendar.POSTbooleandefault false
permission.google-calendar.PUTbooleandefault false
permission.google-calendar.DELETEbooleandefault false
permission.my-google-calendarobject
permission.my-google-calendar.GETbooleandefault false
permission.my-google-calendar.POSTbooleandefault false
permission.my-google-calendar.PUTbooleandefault false
permission.my-google-calendar.DELETEbooleandefault false
permission.offline-meetingobject
permission.offline-meeting.GETbooleandefault false
permission.offline-meeting.POSTbooleandefault false
permission.offline-meeting.PUTbooleandefault false
permission.offline-meeting.DELETEbooleandefault false
permission.genieobject
permission.genie.GETbooleandefault false
permission.genie.POSTbooleandefault false
permission.genie.PUTbooleandefault false
permission.genie.DELETEbooleandefault false
permission.enrichobject
permission.enrich.GETbooleandefault false
permission.enrich.POSTbooleandefault false
permission.enrich.PUTbooleandefault false
permission.enrich.DELETEbooleandefault false
permission.lead-gen-aiobject
permission.lead-gen-ai.GETbooleandefault false
permission.lead-gen-ai.POSTbooleandefault false
permission.lead-gen-ai.PUTbooleandefault false
permission.lead-gen-ai.DELETEbooleandefault false
permission.domain-trackingobject
permission.domain-tracking.GETbooleandefault false
permission.domain-tracking.POSTbooleandefault false
permission.domain-tracking.PUTbooleandefault false
permission.domain-tracking.DELETEbooleandefault false
permission.white-label-optionsobject
permission.white-label-options.GETbooleandefault false
permission.white-label-options.POSTbooleandefault false
permission.white-label-options.PUTbooleandefault false
permission.white-label-options.DELETEbooleandefault false
permission.chat-widgetobject
permission.chat-widget.GETbooleandefault false
permission.chat-widget.POSTbooleandefault false
permission.chat-widget.PUTbooleandefault false
permission.chat-widget.DELETEbooleandefault false
permission.manual-chatbotobject
permission.manual-chatbot.GETbooleandefault false
permission.manual-chatbot.POSTbooleandefault false
permission.manual-chatbot.PUTbooleandefault false
permission.manual-chatbot.DELETEbooleandefault false
permission.workflowobject
permission.workflow.GETbooleandefault false
permission.workflow.POSTbooleandefault false
permission.workflow.PUTbooleandefault false
permission.workflow.DELETEbooleandefault false
permission.ai-crm-chatobject
permission.ai-crm-chat.GETbooleandefault false
permission.ai-crm-chat.POSTbooleandefault false
permission.ai-crm-chat.PUTbooleandefault false
permission.ai-crm-chat.DELETEbooleandefault false
teamsObjectId[] -> Teamdefault []
defaultDashboardObjectId -> Dashboard
connectingAppsObjectId -> MemberConnectingApp
dashboardOrderObjectId[] -> Dashboarddefault []
createdByObjectId -> Member
updatedByObjectId -> Member
_idObjectIddefault "6a95712f932657988a91c0a8"
createdAtdateset once
updatedAtdate