Role

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

Returned by GET /role, POST /role, GET /role/:id, PUT /role/:id.

Example

One real Role as returned by GET /role, taken from the data array. Recorded from a live response, so the defaults, denormalised snapshots and populated fields are the actual ones:

{
  "_id": "6a9572df859eafb47bf225dc",
  "name": "Growth Executive",
  "description": "Manages contacts and runs marketing campaigns.",
  "permission": {
    "custom-field": {
      "GET": true,
      "POST": false,
      "PUT": false,
      "DELETE": false
    },
    "custom-section": {
      "GET": true,
      "POST": false,
      "PUT": false,
      "DELETE": false
    },
    "apps": {
      "GET": true,
      "POST": false,
      "PUT": false,
      "DELETE": false
    },
    "contact": {
      "GET": true,
      "POST": true,
      "PUT": true,
      "DELETE": false
    },
    "template": {
      "GET": true,
      "POST": false,
      "PUT": false,
      "DELETE": false
    },
    "campaign": {
      "GET": true,
      "POST": true,
      "PUT": true,
      "DELETE": false
    },
    "company": {
      "GET": true,
      "POST": false,
      "PUT": false,
      "DELETE": false
    },
    "member": {
      "GET": true,
      "POST": false,
      "PUT": false,
      "DELETE": false
    },
    "role": {
      "GET": true,
      "POST": false,
      "PUT": false,
      "DELETE": false
    },
    "file": {
      "GET": true,
      "POST": false,
      "PUT": false,
      "DELETE": false
    },
    "settings": {
      "GET": true,
      "POST": false,
      "PUT": false,
      "DELETE": false
    }
  },
  "isDefault": true,
  "company": "6a9572df859eafb47bf225d7",
  "__v": 0,
  "createdAt": "2026-08-31T12:26:07.681Z",
  "updatedAt": "2026-08-31T12:26:07.681Z",
  "updatedBy": {},
  "createdBy": {}
}

:::note Trimmed for reading A populated reference is shown by the fields that identify it rather than in full — it arrives as the entire referenced document. Long arrays are cut to the first two entries and marked, long strings are truncated, and any field that could carry a credential is dropped rather than masked. :::

Fields

Field	Type	Notes
`name`	string	required
`description`	string
`permission.custom-field`	object
`permission.custom-field.GET`	boolean	default `false`
`permission.custom-field.POST`	boolean	default `false`
`permission.custom-field.PUT`	boolean	default `false`
`permission.custom-field.DELETE`	boolean	default `false`
`permission.custom-section`	object
`permission.custom-section.GET`	boolean	default `false`
`permission.custom-section.POST`	boolean	default `false`
`permission.custom-section.PUT`	boolean	default `false`
`permission.custom-section.DELETE`	boolean	default `false`
`permission.apps`	object
`permission.apps.GET`	boolean	default `false`
`permission.apps.POST`	boolean	default `false`
`permission.apps.PUT`	boolean	default `false`
`permission.apps.DELETE`	boolean	default `false`
`permission.contact`	object
`permission.contact.GET`	boolean	default `false`
`permission.contact.POST`	boolean	default `false`
`permission.contact.PUT`	boolean	default `false`
`permission.contact.DELETE`	boolean	default `false`
`permission.contact-category`	object
`permission.contact-category.GET`	boolean	default `false`
`permission.contact-category.POST`	boolean	default `false`
`permission.contact-category.PUT`	boolean	default `false`
`permission.contact-category.DELETE`	boolean	default `false`
`permission.lead`	object
`permission.lead.GET`	boolean	default `false`
`permission.lead.POST`	boolean	default `false`
`permission.lead.PUT`	boolean	default `false`
`permission.lead.DELETE`	boolean	default `false`
`permission.lead-activity`	object
`permission.lead-activity.GET`	boolean	default `false`
`permission.lead-activity.POST`	boolean	default `false`
`permission.lead-activity.PUT`	boolean	default `false`
`permission.lead-activity.DELETE`	boolean	default `false`
`permission.template`	object
`permission.template.GET`	boolean	default `false`
`permission.template.POST`	boolean	default `false`
`permission.template.PUT`	boolean	default `false`
`permission.template.DELETE`	boolean	default `false`
`permission.campaign`	object
`permission.campaign.GET`	boolean	default `false`
`permission.campaign.POST`	boolean	default `false`
`permission.campaign.PUT`	boolean	default `false`
`permission.campaign.DELETE`	boolean	default `false`
`permission.whatsapp`	object
`permission.whatsapp.GET`	boolean	default `false`
`permission.whatsapp.POST`	boolean	default `false`
`permission.whatsapp.PUT`	boolean	default `false`
`permission.whatsapp.DELETE`	boolean	default `false`
`permission.report`	object
`permission.report.GET`	boolean	default `false`
`permission.report.POST`	boolean	default `false`
`permission.report.PUT`	boolean	default `false`
`permission.report.DELETE`	boolean	default `false`
`permission.company`	object
`permission.company.GET`	boolean	default `false`
`permission.company.POST`	boolean	default `false`
`permission.company.PUT`	boolean	default `false`
`permission.company.DELETE`	boolean	default `false`
`permission.member`	object
`permission.member.GET`	boolean	default `false`
`permission.member.POST`	boolean	default `false`
`permission.member.PUT`	boolean	default `false`
`permission.member.DELETE`	boolean	default `false`
`permission.role`	object
`permission.role.GET`	boolean	default `false`
`permission.role.POST`	boolean	default `false`
`permission.role.PUT`	boolean	default `false`
`permission.role.DELETE`	boolean	default `false`
`permission.segment`	object
`permission.segment.GET`	boolean	default `false`
`permission.segment.POST`	boolean	default `false`
`permission.segment.PUT`	boolean	default `false`
`permission.segment.DELETE`	boolean	default `false`
`permission.file`	object
`permission.file.GET`	boolean	default `false`
`permission.file.POST`	boolean	default `false`
`permission.file.PUT`	boolean	default `false`
`permission.file.DELETE`	boolean	default `false`
`permission.plan`	object
`permission.plan.GET`	boolean	default `false`
`permission.plan.POST`	boolean	default `false`
`permission.plan.PUT`	boolean	default `false`
`permission.plan.DELETE`	boolean	default `false`
`permission.settings`	object
`permission.settings.GET`	boolean	default `false`
`permission.settings.POST`	boolean	default `false`
`permission.settings.PUT`	boolean	default `false`
`permission.settings.DELETE`	boolean	default `false`
`permission.product-service`	object
`permission.product-service.GET`	boolean	default `false`
`permission.product-service.POST`	boolean	default `false`
`permission.product-service.PUT`	boolean	default `false`
`permission.product-service.DELETE`	boolean	default `false`
`permission.tag`	object
`permission.tag.GET`	boolean	default `false`
`permission.tag.POST`	boolean	default `false`
`permission.tag.PUT`	boolean	default `false`
`permission.tag.DELETE`	boolean	default `false`
`permission.logs`	object
`permission.logs.GET`	boolean	default `false`
`permission.logs.POST`	boolean	default `false`
`permission.logs.PUT`	boolean	default `false`
`permission.logs.DELETE`	boolean	default `false`
`permission.team`	object
`permission.team.GET`	boolean	default `false`
`permission.team.POST`	boolean	default `false`
`permission.team.PUT`	boolean	default `false`
`permission.team.DELETE`	boolean	default `false`
`permission.api`	object
`permission.api.GET`	boolean	default `false`
`permission.api.POST`	boolean	default `false`
`permission.api.PUT`	boolean	default `false`
`permission.api.DELETE`	boolean	default `false`
`permission.meeting`	object
`permission.meeting.GET`	boolean	default `false`
`permission.meeting.POST`	boolean	default `false`
`permission.meeting.PUT`	boolean	default `false`
`permission.meeting.DELETE`	boolean	default `false`
`permission.zoom`	object
`permission.zoom.GET`	boolean	default `false`
`permission.zoom.POST`	boolean	default `false`
`permission.zoom.PUT`	boolean	default `false`
`permission.zoom.DELETE`	boolean	default `false`
`permission.my-zoom`	object
`permission.my-zoom.GET`	boolean	default `false`
`permission.my-zoom.POST`	boolean	default `false`
`permission.my-zoom.PUT`	boolean	default `false`
`permission.my-zoom.DELETE`	boolean	default `false`
`permission.google-calendar`	object
`permission.google-calendar.GET`	boolean	default `false`
`permission.google-calendar.POST`	boolean	default `false`
`permission.google-calendar.PUT`	boolean	default `false`
`permission.google-calendar.DELETE`	boolean	default `false`
`permission.my-google-calendar`	object
`permission.my-google-calendar.GET`	boolean	default `false`
`permission.my-google-calendar.POST`	boolean	default `false`
`permission.my-google-calendar.PUT`	boolean	default `false`
`permission.my-google-calendar.DELETE`	boolean	default `false`
`permission.offline-meeting`	object
`permission.offline-meeting.GET`	boolean	default `false`
`permission.offline-meeting.POST`	boolean	default `false`
`permission.offline-meeting.PUT`	boolean	default `false`
`permission.offline-meeting.DELETE`	boolean	default `false`
`permission.genie`	object
`permission.genie.GET`	boolean	default `false`
`permission.genie.POST`	boolean	default `false`
`permission.genie.PUT`	boolean	default `false`
`permission.genie.DELETE`	boolean	default `false`
`permission.enrich`	object
`permission.enrich.GET`	boolean	default `false`
`permission.enrich.POST`	boolean	default `false`
`permission.enrich.PUT`	boolean	default `false`
`permission.enrich.DELETE`	boolean	default `false`
`permission.lead-gen-ai`	object
`permission.lead-gen-ai.GET`	boolean	default `false`
`permission.lead-gen-ai.POST`	boolean	default `false`
`permission.lead-gen-ai.PUT`	boolean	default `false`
`permission.lead-gen-ai.DELETE`	boolean	default `false`
`permission.domain-tracking`	object
`permission.domain-tracking.GET`	boolean	default `false`
`permission.domain-tracking.POST`	boolean	default `false`
`permission.domain-tracking.PUT`	boolean	default `false`
`permission.domain-tracking.DELETE`	boolean	default `false`
`permission.white-label-options`	object
`permission.white-label-options.GET`	boolean	default `false`
`permission.white-label-options.POST`	boolean	default `false`
`permission.white-label-options.PUT`	boolean	default `false`
`permission.white-label-options.DELETE`	boolean	default `false`
`permission.chat-widget`	object
`permission.chat-widget.GET`	boolean	default `false`
`permission.chat-widget.POST`	boolean	default `false`
`permission.chat-widget.PUT`	boolean	default `false`
`permission.chat-widget.DELETE`	boolean	default `false`
`permission.manual-chatbot`	object
`permission.manual-chatbot.GET`	boolean	default `false`
`permission.manual-chatbot.POST`	boolean	default `false`
`permission.manual-chatbot.PUT`	boolean	default `false`
`permission.manual-chatbot.DELETE`	boolean	default `false`
`permission.workflow`	object
`permission.workflow.GET`	boolean	default `false`
`permission.workflow.POST`	boolean	default `false`
`permission.workflow.PUT`	boolean	default `false`
`permission.workflow.DELETE`	boolean	default `false`
`permission.ai-crm-chat`	object
`permission.ai-crm-chat.GET`	boolean	default `false`
`permission.ai-crm-chat.POST`	boolean	default `false`
`permission.ai-crm-chat.PUT`	boolean	default `false`
`permission.ai-crm-chat.DELETE`	boolean	default `false`
`isDefault`	boolean	default `false`
`company`	ObjectId -> Company
`createdBy`	ObjectId -> Member
`updatedBy`	ObjectId -> Member
`_id`	ObjectId
`createdAt`	date	set once
`updatedAt`	date

Example​

Fields​

Example

Fields