Everbridge

Everbridge Custom Roles API

EB Suites - Custom Roles.

Documentation GitHub OpenAPI

Operations 6

GET /v1/roles List Custom Roles #

POST /v1/roles Create Custom Role #

DELETE /v1/roles/{roleId} Delete Custom Role #

GET /v1/roles/{roleId} Get Custom Role #

PATCH /v1/roles/{roleId} Patch Custom Role #

PUT /v1/roles/{roleId} Update Custom Role #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/everbridge-custom-roles-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  description: EB Suite APIs.
  title: EB Suite Custom Roles API
  version: '1.0'
servers:
- url: https://api.everbridge.net/rest
- url: https://api.everbridge.eu/rest
tags:
- description: EB Suites - Custom Roles.
  name: Custom Roles
paths:
  /v1/roles:
    get:
      description: Retrieve all roles within an organization, with optional filtering by roleTemplate.
      operationId: EBS Get Custom Roles In Organization
      parameters:
      - description: Organization ID
        in: query
        name: organizationId
        required: true
        schema:
          type: integer
      - description: 'Filter the roles based on the roleTemplate. '
        in: query
        name: roleTemplate
        required: false
        schema:
          description: The valid roleTemplate value for custom-role query.
          enum:
          - CUSTOMIZED
          - DATA_MANAGER
          - GROUP_MANAGER
          - DISPATCHER
          - INCIDENT_ADMIN
          - INCIDENT_OPERATOR
          - MASS_NOTIFICATION_OPERATOR
          - ORGANIZATION_ADMIN
          type: string
      - description: The page number of query result. The default value is 1.
        in: query
        name: pageNumber
        required: false
        schema:
          default: 1
          type: integer
      - description: The page size of query result. The default value is 100.
        in: query
        name: pageSize
        required: false
        schema:
          default: 100
          type: integer
      - description: To control if the response should include detailed role data.
        in: query
        name: verbose
        required: false
        schema:
          default: false
          type: boolean
      responses:
        '200':
          content:
            application/json:
              examples:
                verboseIsFalse:
                  summary: verbose=false
                  value:
                    firstPageUri: https://api-dev3.everbridge.net/rest/v1/roles?organizationId=1561998001176578&verbose=false&pageNumber=1
                    lastPageUri: https://api-dev3.everbridge.net/rest/v1/roles?organizationId=1561998001176578&verbose=false&pageNumber=1
                    message: OK
                    page:
                      currentPageNo: 1
                      data:
                      - baseRoleTemplate: DATA_MANAGER
                        id: 443345314775163
                        name: CR-demoPatch
                        roleTemplate: CUSTOMIZED
                      - baseRoleTemplate: DATA_MANAGER
                        id: 443345314775171
                        name: COR-121037-a115a
                        roleTemplate: CUSTOMIZED
                      pageSize: 100
                      start: 0
                      totalCount: 2
                      totalPageCount: 1
                verboseIsTrue:
                  summary: verbose=true
                  value:
                    firstPageUri: https://api-dev3.everbridge.net/rest/v1/roles?organizationId=1561998001176578&verbose=true&pageNumber=1
                    lastPageUri: https://api-dev3.everbridge.net/rest/v1/roles?organizationId=1561998001176578&verbose=true&pageNumber=1
                    message: OK
                    page:
                      currentPageNo: 1
                      data:
                      - baseRoleTemplate: DATA_MANAGER
                        createdDate: '2025-04-24T04:03:59.576Z'
                        createdName: georgeRestApi Dahui
                        id: 443345314775163
                        lastModifiedDate: '2025-05-07T02:13:02.713Z'
                        lastModifiedName: georgeRestApi Dahui
                        name: CR-demoPatch
                        organizationId: 1561998001176578
                        permissionScope:
                          accessEverbridgeMobileAppMessages: false
                          accessFlowDesigner: false
                          accessRIMCAlerts: false
                          accessRIMCFeedsAndAlerts: false
                          accessSafetyMessages: false
                          accessWeatherAlerts: false
                          accountSettings: false
                          addContactsToGroups: true
                          additionalInformation: false
                          alertActions: false
                          alertCustomActions: false
                          alertManagement: false
                          amexGBTTravelConnector: false
                          assetManagement: false
                          assetManagementSetting: false
                          broadcastDefaultSetting: false
                          cemAnalyticsCustomDashboard: false
                          cmAddDownloadReports: false
                          cmAddTaskListsToEvent: false
                          cmAddUpdateCopyDownloadFormReports: false
                          cmDeleteCriticalEvents: false
                          cmDeleteReports: false
                          cmDeleteShareTrackers: false
                          cmDeleteSingleEventDashboards: false
                          cmDeleteSubmissions: false
                          cmDeleteSubmissionsFromEvent: false
                          cmDeleteTaskListsFromEvent: false
                          cmDeleteTrackerRecords: false
                          cmDownloadAffectedAssets: false
                          cmDownloadCriticalEvents: false
                          cmExportAuditLogs: false
                          cmGetMultipleEventDashboardPublicLink: false
                          cmLaunchUpdateCriticalEvents: false
                          cmLaunchUpdateTaskListsInEvent: false
                          cmLinkSubmissionsToEvents: false
                          cmLockTaskOrder: false
                          cmLockUnlockDeleteFormReports: false
                          cmManageAffectedAssetAggregations: false
                          cmManageCriticalEventTemplates: false
                          cmManageDocumentLibrary: false
                          cmManageDocumentsInEvent: false
                          cmManageDocumentsInEventTemplate: false
                          cmManageFolders: false
                          cmManageForms: false
                          cmManageIncidentTemplatesInEvent: false
                          cmManageIncidentTemplatesInEventTemplate: false
                          cmManageLegacySituationReports: false
                          cmManageMultipleEventDashboardWidgets: false
                          cmManageNotesInEvent: false
                          cmManageSingleEventDashboards: false
                          cmManageSubmissions: false
                          cmManageTaskListTemplates: false
                          cmManageTrackerTabs: false
                          cmManageTrackers: false
                          cmManageWidgetLibrary: false
                          cmPublishEventToContacts: false
                          cmSetSubmissionStatus: false
                          cmShareFormWithContacts: false
                          cmViewAffectedAssetAggregations: false
                          cmViewAffectedAssets: false
                          cmViewAuditLogs: false
                          cmViewCriticalEventTemplates: false
                          cmViewCriticalEvents: false
                          cmViewDownloadDocumentLibrary: false
                          cmViewFolders: false
                          cmViewForms: false
                          cmViewIncidentTemplatesInEvent: false
                          cmViewIncidentTemplatesInEventTemplate: false
                          cmViewMultipleEventDashboards: false
                          cmViewReports: false
                          cmViewSingleEventDashboards: false
                          cmViewSubmissions: false
                          cmViewTaskListTemplates: false
                          cmViewTrackers: false
                          cmViewWidgetLibrary: false
                          communicationCreate: false
                          communicationRecipientSettings: false
                          communicationSettings: false
                          communicationTemplateCreate: false
                          communicationTemplateDelete: false
                          communicationTemplateUpdate: false
                          communicationTemplateView: false
                          communicationView: false
                          concurV2: false
                          contactAddEditDeleteViewListDownloadAddtogroupSaveasrule: false
                          contactAndGroupSettings: false
                          contactTracingCorpAnonymous: false
                          contactTracingCorpSetting: false
                          contactTracingHarald: false
                          contactTracingSlg: false
                          createAmsMessage: false
                          createAndEditAssetType: false
                          createAsset: false
                          createContacts: true
                          createEditDeleteCustomReport: true
                          createEditDeleteGroups: true
                          createEditDeleteMessageTemplate: false
                          createEditDeleteResponseSubscriptions: false
                          createEditDeleteRules: true
                          createEditDeleteSchedules: false
                          createEditViewCockpitWorkFlows: false
                          createNotification: false
                          createScheduleIncident: false
                          createUpdateSurveyTemplate: false
                          crisisEventTypeSetting: false
                          crossOrgContactUpload: false
                          crossOrganizationBroadcastSetting: false
                          crossOrganizationNewNotificationAddSendnowSaveasbroadcasttemplateSaveasmessagetemplateUploadattachedfile: false
                          customFromEmail: false
                          customReportIncidentAddEditDeleteViewListExport: false
                          customReportIncidentScenarioAddEditDeleteViewListExport: false
                          customReportMatrixNotificationAddEditDeleteViewListExport: false
                          customReportNotificationAddEditDeleteViewListExport: false
                          customReportScenarioNotificationAddEditDeleteViewListExport: false
                          customReportTravelAddEditDeleteViewListExport: false
                          customRoleTestFeature1: false
                          customRoleTestFeature10: false
                          customRoleTestFeature101: false
                          customRoleTestFeature102: false
                          customRoleTestFeature103: false
                          customRoleTestFeature104: false
                          customRoleTestFeature105: false
                          customRoleTestFeature106: false
                          customRoleTestFeature107: false
                          customRoleTestFeature108: false
                          customRoleTestFeature109: false
                          customRoleTestFeature110: false
                          customRoleTestFeature111: false
                          customRoleTestFeature112: false
                          customRoleTestFeature113: false
                          customRoleTestFeature114: false
                          customRoleTestFeature115: false
                          customRoleTestFeature116: false
                          customRoleTestFeature117: false
                          customRoleTestFeature118: false
                          customRoleTestFeature2: false
                          customRoleTestFeature3: false
                          customRoleTestFeature4: false
                          customRoleTestFeature5: false
                          customRoleTestFeature6: false
                          customRoleTestFeature7: false
                          customRoleTestFeature8: false
                          customRoleTestFeature9: false
                          customSenderSmsId: false
                          customSmsCodes: false
                          customizableButton: false
                          dashboardView: false
                          deleteAmsMessage: false
                          deleteAsset: false
                          deleteAssetType: false
                          deleteContacts: true
                          directoryChat: false
                          disableNixleShortURL: false
                          downloadContacts: true
                          eb360LaunchCrisisEvent: false
                          ebAdminAccountAdminUserCreate: false
                          ebAdminAccountAdminUserDelete: false
                          ebAdminAccountAdminUserEdit: false
                          ebAdminAccountAdminUserReset-password: false
                          ebAdminAccountAdminUserSwitch: false
                          ebAdminAccountAdminUserView: false
                          ebAdminAccountClientType: false
                          ebAdminAccountCreate: false
                          ebAdminAccountDemoType: false
                          ebAdminAccountEdit: false
                          ebAdminAccountInternalType: false
                          ebAdminAccountNixleStandaloneType: false
                          ebAdminAccountPartnerType: false
                          ebAdminAccountPilotType: false
                          ebAdminAccountStaffType: false
                          ebAdminAccountSwitch: false
                          ebAdminAccountTslimit: false
                          ebAdminAccountView: false
                          ebAdminApiUserCreate: false
                          ebAdminApiUserDelete: false
                          ebAdminApiUserRate-limit: false
                          ebAdminApiUserView: false
                          ebAdminAutoProvisionAll: false
                          ebAdminAutoProvisionView: false
                          ebAdminContactSyncGroupCreate: false
                          ebAdminContactSyncGroupEdit: false
                          ebAdminContactSyncGroupSwitch: false
                          ebAdminContactSyncGroupView: false
                          ebAdminContractSubscriptionCreate: false
                          ebAdminContractSubscriptionDelete: false
                          ebAdminContractSubscriptionEdit: false
                          ebAdminContractSubscriptionView: false
                          ebAdminEmployeeUserDelete: false
                          ebAdminEmployeeUserSwitch: false
                          ebAdminEmployeeUserView: false
                          ebAdminNetworkGroupCreate: false
                          ebAdminNetworkGroupEdit: false
                          ebAdminNetworkGroupSwitch: false
                          ebAdminNetworkGroupView: false
                          ebAdminNixleAll: false
                          ebAdminOrganizationCreate: false
                          ebAdminOrganizationEdit: false
                          ebAdminOrganizationSwitch: false
                          ebAdminOrganizationView: false
                          ebAdminProvisioningUserAccount-full-access: false
                          ebAdminProvisionmappingCreate: false
                          ebAdminProvisionmappingDelete: false
                          ebAdminProvisionmappingEdit: false
                          ebAdminProvisionmappingView: false
                          ebAdminReportsAll: false
                          ebAdminRoleCreate: false
                          ebAdminRoleDelete: false
                          ebAdminRoleEdit: false
                          ebAdminRoleView: false
                          ebAdminSmartConferenceAll: false
                          ebAdminSupportAccount: false
                          ebAdminSupportAccount-account-admin-only: false
                          ebAdminSupportAccount-full-access: false
                          ebAdminSupportAssume-client-user: false
                          ebAdminSupportTerminateSession: false
                          ebAdminSupportUserCreate: false
                          ebAdminSupportUserDelete: false
                          ebAdminSupportUserEdit: false
                          ebAdminSupportUserReset-password: false
                          ebAdminSupportUserSwitch: false
                          ebAdminSupportUserView: false
                          ebAdminSupportView: false
                          ebAdminUserCreate: false
                          ebAdminUserDelete: false
                          ebAdminUserEdit: false
                          ebAdminUserReset-password: false
                          ebAdminUserSwitch: false
                          ebAdminUserView: false
                          ebOpenIpaas: false
                          editAmsMessage: false
                          editAsset: false
                          editDeleteViewsOthervccs: false
                          editNotificationTemplate: false
                          emailIngestion: false
                          emailIngestionView: false
                          enforcePrivacyOptions: false
                          euWeatherAlerts: false
                          eventTypeCreate: false
                          eventTypeDelete: false
                          eventTypeEdit: false
                          filterByImport: false
                          gisSetting: false
                          googlePublicAlertsSetting: false
                          googleTranslate: false
                          groupAddEditDeleteViewListRemovecontactfromgroup: false
                          groupSetting: true
                          historicalRiskEventVisualization: false
                          incidentChat: false
                          incidentScenarioSettings: false
                          incidentTemplateAddEditDeleteViewListCopy: false
                          incidentTemplateDownloadUpload: false
                          incidentZonePrivateInIncident: false
                          incidentZonePublicInIncident: false
                          incidentZonePublicInNotification: false
                          incidentZonesPrivateInNotification: false
                          increaseZoomLevels: true
                          informationVariableAddEditDeleteViewListCopy: false
                          interactiveVisibility: false
                          internationalSOSTravelConnector: false
                          itaDashboard: false
                          itaDashboardSettings: false
                          kmlPermanetFeed: false
                          launchAndUpdateCommunicationsInTrainingModeOnly: false
                          launchByPhoneSettings: false
                          launchCommunicationWithoutTemplate: false
                          launchIncident: false
                          launchIncidentByPhone: false
                          launchMultipleCommunications: false
                          launchNotificationByPhone: false
                          limitedAlerting: false
                          listAmsMessage: false
                          listEditNotification: false
                          locationDataRetention: false
                          locationInWeatherAlertsVoice: false
                          locationTracingInsideGeofence: false
                          loginToSnapcomms: false
                          manageBookingAlerts: false
                          manageBuildings: false
                          manageRiskIntelligence: false
                          manageScenarioTemplate: false
                          manageScheduleNotification: false
                          manageTravelApprovalPolicies: false
                          manageTravelConnector: false
                          manageTravelItineraries: false
                          mapFindcontactSelectcontactMaplayer: false
                          memberPortalAlternativeRegistration: false
                          memberPortalNationalRegistryLoginUms: false
                          memberPortalOptInGroups: false
                          memberPortalSetting: false
                          memberPortalTestNotifications: false
                          memberPortalWeatherPages: false
                          mobileAppSafetySettingsSAFETY_DEVICE_RISKBAND: false
                          mobileFollowup: false
                          mobileOptin: false
                          mobileRebroadcast: false
                          mobileSecureMessage: false
                          mobileSend: false
                          mobileSendtemplate: false
                          mobileStop: false
                          moveRemoveContactsFromGroups: true
                          nationalRegistry: false
                          nixleEventSubscriptionsSettings: false
                          notificationButtonNotificationwidget: false
                          notificationShownotification: false
                          notificationsToMemberPortalSetting: false
                          onlyEditRulesWithSameRole: false
                          orchestrationRules: false
                          organizationSettingSetting: false
                          organizationUserRoleManagement: false
                          pointAddressGeocoding: false
                          precisiongisCustomMap: false
                          publishOptionABBSettings: false
                          publishOptionCAPRSSSettings: false
                          publishOptionPABBSettings: false
                          publishOptionsIPAWSSettings: false
                          publishToABB: false
                          publishToAlertus: false
                          publishToCAPRSS: false
                          publishToCOGToCOG: false
                          publishToEAS: false
                          publishToEBDesktopAlerts: false
                          publishToEBNetwork: false
                          publishToEBWebWidget: false
                          publishToGPA: false
                          publishToMemberPortal: false
                          publishToNWEM: false
                          publishToNixleCommunitySubscribers: false
                          publishToNixleEventSubscribers: false
                          publishToSocialMedia: false
                          publishToWEA: false
                          publishToWebPosting: false
                          quickReportView: false
                          rcNa: false
                          registryPortalSettings: false
                          reopenIncident: false
                          reportingPlatformCreator: false
                          reportingPlatformExportData: false
                          reportingPlatformSchedule: false
                          reportingPlatformViewer: false
                          restrictNotificationToSimulation: false
                          restrictToIncidentSimulationOnly: false
                          restrictionEditDeleteScenarios: true
                          restrictionEditDeleteTemplates: true
                          roleAddEditDeleteViewList: false
                          safetyBridgeAppleWatch: false
                          safetyBridgeItag: false
                          safetyDevice: false
                          safetyDevicePersonal: false
                          safetyDeviceRiskband: false
                          safetyDevicesRegistrationAndConfiguration: false
                          safetyThresholdSettings: false
                          scenarioLaunchManage: false
                          schedulingSend: false
                          schedulingView: true
                          secureP2pCarechat: false
                          secureP2pDecryption: false
                          secureP2pHipaachat: false
                          secureP2pSecurebridge: false
                          securePush: false
                          sequencedGroup: true
                          singleSignOn: false
                          smartConferenceBridge: false
                          smartOrchestration: false
                          smartOrchestrationEnableWorkflowEditing: false
                          smartSecurity: false
                          smartSecurityUseAdminConsole: false
                          smartSecurityUseOperatorConsole: false
                          socialMediaSettings: false
                          templateSend: false
                          testNewFeature: false
                          travelConnectors: false
                          triggers: false
                          twitterShowtwitterwidget: false
                          uploadAsset: false
                          uploadContacts: false
                          uploadDynamicLocations: false
                          usWeatherAlerts: false
                          usageReport: false
                          usageReportApiMetricSource: false
                          usageReportContact: false
                          usageReportMessagingMinutes: false
                          usageReportRiskEvents: false
                          usageReportSetting: false
                          useAlertManagementUi: false
                          userAddEditDeleteListEnableDisabledSendmailLinkcontact: false
                          variableCreate: false
                          variableDelete: false
                          variableUpdate: false
                          variableView: false
                          vccAdminConsole: false
                          vccOperatorConsole: false
                          vccUseChannels: false
                          vccUseCustomAlertActions: false
                          viewAllIncidents: false
                          viewAmsMessage: false
                          viewAndDownloadAsset: false
                          viewAndExportEventLog: false
                          viewAssetType: false
                          viewBuildingAirportRailwayStationLayer: false
                          viewCockpitWorkFlows: false
                          viewContactLocationHistory: false
                          viewContactTracingInformation: false
                          viewDownloadAllContacts: true
                          viewDownloadEditAllContacts: true
                          viewItinerariesAndSegments: false
                          viewLastKnownAndExpectedLocation: false
                          viewNotificationTemplate: false
                          viewResponseSubscriptions: false
                          viewRiskIntelligence: false
                          viewSurveyTemplate: false
                          viewTravelReports: false
                          wdtPremium: false
                          weatherFeaturesOption: false
                          webhookSubscription: false
                          xmIncidents: false
                          xmattersFlowDesigner: false
                        resourceScope:
                          calendar:
                            accessScope: selected
                            calendarsSelected:
                            - '1707408413949953'
                            restrictOwned: true
                            restrictSelected: false
                          communication:
                            incident:
                              canViewAll: false
                              isRestrictToOwnerRole: true
                            incidentTemplate:
                              accessScope: all
                              isRestrictToOwnerRole: true
                            isAccessToAllResource: false
                            notification:
                              isRestrictToOwnerRole: true
                            notificationTemplate:
                              accessScope: all
                              isRestrictToOwnerRole: true
                            scenarioTemplate:
                              accessScope: all
                              isRestrictToOwnerRole: true
                          contact:
                            accessScope: selected
                            dynamicGroupIds: []
                            groupIds:
                            - 1759085460456471
                        roleTemplate: CUSTOMIZED
                      - createdDate: '2021-12-14T02:36:13.744Z'
                        createdName: Haihui - Dev3 Wang
                        id: 1561998001176579
                        lastModifiedDate: '2024-11-26T01:57:28.701Z'
                        lastModifiedName: Haihui - Dev3 Wang
                        name: Organization Admin
                        organizationId: 1561998001176578
                        roleTemplate: ORGANIZATION_ADMIN
                      pageSize: 100
                      start: 0
                      totalCount: 2
                      totalPageCount: 1
              schema:
                oneOf:
                - properties:
                    message:
                      type: string
                    result:
                      properties:
                        baseRoleTemplate:
                          type: string
                        id:
                          type: integer
                        name:
                          type: string
                        roleTemplate:
                          type: string
                      type: object
                  type: object
                - properties:
                    message:
                      type: string
                    result:
                      properties:
                        baseRoleTemplate:
                          type: string
                        id:
                          type: integer
                        name:
                          type: string
                        organizationId:
                          type: integer
                        permissionScope:
                          properties:
                            configurable:
                              items:
                                properties:
                                  apiFeatureName:
                                    type: string
                                  value:
                                    type: boolean
                                type: object
                              type: array
                            unavailable:
                              items:
                                type: string
                              type: array
                            unconfigurable:
                              items:
                                properties:
                                  apiFeatureName:
                                    type: string
                                  value:
                                    type: boolean
                                type: object
                              type: array
                          type: object
                        resourceScope:
                          properties:
                            calendar:
                              properties:
                                accessScope:
                                  description: The valid access scope values. The default value is 'all'.
                                  enum:
                                  - all
                                  - selected
                                  - roleOwned
                                  type: string
                                calendarsSelected:
                                  items:
                                    type: string
                                  type: array
                                restrictOwned:
                                  type: boolean
                                restrictSelected:
                                  type: boolean
                              type: object
                            communication:
                              properties:
                                incident:
                                

# --- truncated at 32 KB (200 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/everbridge/refs/heads/main/openapi/everbridge-custom-roles-api-openapi.yml