Everbridge Record Types API

EB Suites - Contact Record Type Management

Operations 5

GET /recordTypes/{organizationId} List Record Types #
POST /recordTypes/{organizationId} Create Record Type #
DELETE /recordTypes/{organizationId}/{recordTypeId} Delete Record Type #
GET /recordTypes/{organizationId}/{recordTypeId} Get Record Type #
PUT /recordTypes/{organizationId}/{recordTypeId} Update Record Type #

Documentation

📖
Documentation
https://developers.everbridge.net/home/docs/overview
📖
APIReference
https://developers.everbridge.net/home/reference
📖
GettingStarted
https://developers.everbridge.net/home/docs/ebs-gs-guide
📖
Authentication
https://developers.everbridge.net/home/docs/ebs-gs-guide-authentication-types
📖
APIReference
https://developers.everbridge.net/home/reference/generate-token
📖
APIReference
https://developers.everbridge.net/home/reference/comms-apis
📖
APIReference
https://developers.everbridge.net/home/reference/authorization
📖
GettingStarted
https://developers.everbridge.net/home/docs/notifications
📖
APIReference
https://developers.everbridge.net/home/reference/cema-query-public
📖
APIReference
https://developers.everbridge.net/home/reference/cema-query-stream-1
📖
APIReference
https://developers.everbridge.net/home/reference/assets
📖
APIReference
https://developers.everbridge.net/home/reference/assets-query
📖
APIReference
https://developers.everbridge.net/home/reference/travel-risk-intelligence
📖
APIReference
https://developers.everbridge.net/home/reference/checks
📖
APIReference
https://developers.everbridge.net/home/reference/risk-events
📖
APIReference
https://developers.everbridge.net/home/reference/safety-devices-event
📖
APIReference
https://developers.everbridge.net/home/reference/snapcomms-authentication
📖
GettingStarted
https://support.snapcomms.com/hc/en-us/articles/19361020051867-Integration-Through-API-Overview

Specifications

Other Resources

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-record-types-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.

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

OpenAPI Specification

everbridge-record-types-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  description: EB Suite APIs.
  title: EB Suite Record Types API
  version: '1.0'
servers:
- url: https://api.everbridge.net/rest
- url: https://api.everbridge.eu/rest
tags:
- description: EB Suites - Contact Record Type Management
  name: Record Types
paths:
  /recordTypes/{organizationId}:
    get:
      operationId: EBS List Record Types
      parameters:
      - description: The ID of the organization containing the contact record types
        in: path
        name: organizationId
        required: true
        schema:
          format: int64
          type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestfulCollectionResult'
          description: OK
        '400':
          description: Missing or invalid request input
        '401':
          description: Invalid or missing credentials
        '500':
          description: Internal Error
      security:
      - BasicAuth: []
      - API_Authorizer: []
      - api_key: []
      summary: List Record Types
      tags:
      - Record Types
      x-amazon-apigateway-integration:
        httpMethod: GET
        passthroughBehavior: when_no_match
        requestParameters:
          integration.request.path.organizationId: method.request.path.organizationId
        responses:
          default:
            statusCode: '200'
        type: http_proxy
        uri: https://ebs-restapi-prod-us.evbg.io/rest/recordTypes/{organizationId}
    post:
      operationId: EBS Create Record Type
      parameters:
      - description: The ID of the organization containing the contactRecordTypes
        in: path
        name: organizationId
        required: true
        schema:
          format: int64
          type: integer
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ContactRecordTypeWrapper'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestfulModificationResult'
          description: OK
        '400':
          description: Missing or invalid request input
        '401':
          description: Invalid or missing credentials
        '500':
          description: Internal Error
      security:
      - BasicAuth: []
      - API_Authorizer: []
      - api_key: []
      summary: Create Record Type
      tags:
      - Record Types
      x-amazon-apigateway-integration:
        httpMethod: POST
        passthroughBehavior: when_no_match
        requestParameters:
          integration.request.path.organizationId: method.request.path.organizationId
        responses:
          default:
            statusCode: '200'
        type: http_proxy
        uri: https://ebs-restapi-prod-us.evbg.io/rest/recordTypes/{organizationId}
  /recordTypes/{organizationId}/{recordTypeId}:
    delete:
      operationId: EBS Delete Record Type
      parameters:
      - description: The ID of the organization containing the contactRecordTypes
        in: path
        name: organizationId
        required: true
        schema:
          format: int64
          type: integer
      - description: The ID of the contactRecordType to delete
        in: path
        name: recordTypeId
        required: true
        schema:
          format: int64
          type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestfulModificationResult'
          description: OK
        '400':
          description: Missing or invalid request input
        '401':
          description: Invalid or missing credentials
        '500':
          description: Internal Error
      security:
      - BasicAuth: []
      - API_Authorizer: []
      - api_key: []
      summary: Delete Record Type
      tags:
      - Record Types
      x-amazon-apigateway-integration:
        httpMethod: DELETE
        passthroughBehavior: when_no_match
        requestParameters:
          integration.request.path.organizationId: method.request.path.organizationId
          integration.request.path.recordTypeId: method.request.path.recordTypeId
        responses:
          default:
            statusCode: '200'
        type: http_proxy
        uri: https://ebs-restapi-prod-us.evbg.io/rest/recordTypes/{organizationId}/{recordTypeId}
    get:
      operationId: EBS Get Record Type
      parameters:
      - description: The ID of the organization containing the contactRecordTypes
        in: path
        name: organizationId
        required: true
        schema:
          format: int64
          type: integer
      - description: The ID of the contactRecordType to return
        in: path
        name: recordTypeId
        required: true
        schema:
          format: int64
          type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestfulInstanceResult'
          description: OK
        '400':
          description: Missing or invalid request input
        '401':
          description: Invalid or missing credentials
        '500':
          description: Internal Error
      security:
      - BasicAuth: []
      - API_Authorizer: []
      - api_key: []
      summary: Get Record Type
      tags:
      - Record Types
      x-amazon-apigateway-integration:
        httpMethod: GET
        passthroughBehavior: when_no_match
        requestParameters:
          integration.request.path.organizationId: method.request.path.organizationId
          integration.request.path.recordTypeId: method.request.path.recordTypeId
        responses:
          default:
            statusCode: '200'
        type: http_proxy
        uri: https://ebs-restapi-prod-us.evbg.io/rest/recordTypes/{organizationId}/{recordTypeId}
    put:
      operationId: EBS Update Record Type
      parameters:
      - description: The ID of the organization containing the contactRecordTypes
        in: path
        name: organizationId
        required: true
        schema:
          format: int64
          type: integer
      - description: The ID of the contactRecordType to update
        in: path
        name: recordTypeId
        required: true
        schema:
          format: int64
          type: integer
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ContactRecordTypeWrapper'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestfulModificationResult'
          description: OK
        '400':
          description: Missing or invalid request input
        '401':
          description: Invalid or missing credentials
        '500':
          description: Internal Error
      security:
      - BasicAuth: []
      - API_Authorizer: []
      - api_key: []
      summary: Update Record Type
      tags:
      - Record Types
      x-amazon-apigateway-integration:
        httpMethod: PUT
        passthroughBehavior: when_no_match
        requestParameters:
          integration.request.path.organizationId: method.request.path.organizationId
          integration.request.path.recordTypeId: method.request.path.recordTypeId
        responses:
          default:
            statusCode: '200'
        type: http_proxy
        uri: https://ebs-restapi-prod-us.evbg.io/rest/recordTypes/{organizationId}/{recordTypeId}
components:
  schemas:
    RestfulInstanceResult:
      properties:
        message:
          type: string
        result:
          type: object
      title: RestfulInstanceResult
      type: object
    RestfulModificationResult:
      properties:
        baseUri:
          type: string
        id:
          format: int64
          type: integer
        instanceUri:
          type: string
        message:
          type: string
      title: RestfulModificationResult
      type: object
    RestfulCollectionResult:
      properties:
        currentPageUri:
          type: string
        firstPageUri:
          type: string
        lastPageUri:
          type: string
        message:
          type: string
        nextPageUri:
          type: string
        page:
          $ref: '#/components/schemas/DataPageObject'
        previousPageUri:
          type: string
      title: RestfulCollectionResult
      type: object
    DataPageObject:
      properties:
        currentPageNo:
          format: int32
          type: integer
        data:
          items:
            type: object
          type: array
        dataPageList:
          items:
            $ref: '#/components/schemas/DataPageObject'
          type: array
        pageSize:
          format: int32
          type: integer
        scrollId:
          type: string
        start:
          format: int32
          type: integer
        totalCount:
          format: int64
          type: integer
        totalPageCount:
          format: int32
          type: integer
      title: DataPage«object»
      type: object
    ContactRecordTypeWrapper:
      description: JSON object describing the new contactRecordType
      properties:
        accountId:
          format: int64
          type: integer
        cachedContactCount:
          format: int64
          type: integer
        createdDate:
          format: date-time
          type: string
        createdId:
          format: int64
          type: integer
        createdName:
          type: string
        createdProxyName:
          type: string
        fillColor:
          type: string
        id:
          format: int64
          type: integer
        lastModifiedDate:
          format: date-time
          type: string
        lastModifiedId:
          format: int64
          type: integer
        lastModifiedName:
          type: string
        lastModifiedProxyName:
          type: string
        name:
          type: string
        organizationId:
          format: int64
          type: integer
        recordType:
          enum:
          - CUSTOMIZE
          - DEFAULT
          - TRM_DEFAULT
          type: string
        resourceBundleId:
          format: int64
          type: integer
        status:
          enum:
          - A
          - D
          type: string
      type: object
  securitySchemes:
    API_Authorizer:
      description: oAuth Token
      in: header
      name: Authorization
      type: apiKey
      x-amazon-apigateway-authorizer:
        authorizerCredentials: arn:aws:iam::214792946631:role/oas-rest-api-gw-prod-us-us-east-1-0-us-east-1-gw
        authorizerResultTtlInSeconds: 300
        authorizerUri: arn:aws:apigateway:us-east-1:lambda:path/2015-03-31/functions/arn:aws:lambda:us-east-1:214792946631:function:API_Authorizer_us-east-1_prod:live/invocations
        identitySource: method.request.header.Authorization,method.request.header.PathCacheKey,method.request.header.MethodCacheKey
        type: request
      x-amazon-apigateway-authtype: custom
    BasicAuth:
      description: Basic Authentication Token
      scheme: basic
      type: http
    api_key:
      description: API Key - For System Use
      in: header
      name: x-api-key
      type: apiKey
x-amazon-apigateway-binary-media-types:
- audio/wav
- audio/x-wav
- application/octet-stream
x-readme:
  explorer-enabled: true
  proxy-enabled: true