Everbridge

Everbridge Uploads API

EB Suites - Uploads

Documentation GitHub OpenAPI

Operations 13

GET /dynamicGroups/{organizationId} List Dynamic Groups #

GET /dynamicGroups/{organizationId}/{dynamicGroupId} Get Dynamic Groups Details #

POST /dynamicLocations/{organizationId} Upload Dynamic Locations #

GET /dynamicLocations/{organizationId}/{uploadBatchId} Get Upload Dynamic Locations Details #

GET /uploadContacts/{organizationId}/groups/{uploadBatchId} Get Contacts Group Upload Details #

GET /uploadContacts/{organizationId}/{uploadBatchId} Get Contacts Upload Details #

GET /uploadDynamicLocations/{organizationId}/{uploadBatchId} Get Upload Dynamic Locations Details #

GET /uploads/{organizationId} List Upload Contacts #

POST /uploads/{organizationId} Upload Contacts #

GET /uploads/{organizationId}/groups List Upload Contacts Groups #

POST /uploads/{organizationId}/groups Upload Contacts Groups #

GET /uploads/{organizationId}/groups/{uploadBatchId} Get Contacts Groups Upload Status #

GET /uploads/{organizationId}/{uploadBatchId} Get Contacts Upload Status #

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-uploads-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 Uploads API
  version: '1.0'
servers:
- url: https://api.everbridge.net/rest
- url: https://api.everbridge.eu/rest
tags:
- description: EB Suites - Uploads
  name: Uploads
paths:
  /dynamicGroups/{organizationId}:
    get:
      description: Retrieve all the dynamic groups for an orgnization.
      operationId: EBS List Dynamic Groups
      parameters:
      - description: The ID of the organization containing the upload
        in: path
        name: organizationId
        required: true
        schema:
          $ref: '#/components/schemas/organizationId'
      - description: The page number of dynamicGroups to return
        in: query
        name: pageNumber
        required: false
        schema:
          default: 1
          type: integer
      responses:
        '200':
          content:
            application/json:
              examples:
                success:
                  summary: success
                  value:
                    firstPageUri: https://api-dev3.everbridge.net/rest/dynamicGroups/1536984111644674?pageNumber=1
                    lastPageUri: https://api-dev3.everbridge.net/rest/dynamicGroups/1536984111644674?pageNumber=1
                    message: OK
                    page:
                      currentPageNo: 1
                      data:
                      - accountId: 0
                        contactFilterRules:
                        - columnName: externalId
                          columnValue: everbridge.com
                          contactFieldId: 7
                          contactFilterOption: ENDWITH
                          dataType: STRING
                          operator: ENDWITH
                          type: SYSTEM
                        contactFilterType: DataScope
                        createdId: 0
                        dirty: true
                        fillColor: '#311b92'
                        id: 2702291954040833
                        lastModifiedDate: 1734594670923
                        lastModifiedId: 0
                        lastModifiedName: Vishal Agrawal
                        lastModifiedTime: 0
                        lastSynchronizedTime: 0
                        name: Dynamic_group_1
                        organizationId: 0
                        resourceBundleId: 1536846672691203
                      pageSize: 100
                      start: 0
                      totalCount: 1
                      totalPageCount: 1
              schema:
                $ref: '#/components/schemas/DynamicGroupResponseListSchema'
          description: OK
        '400':
          content:
            application/json:
              examples:
                Type Mismatch Exception:
                  summary: Type mismatch exception
                  value:
                    message: type mismatch exception
                    status: 400
              schema:
                properties:
                  message:
                    description: Error message
                    type: string
                  status:
                    description: Type mismatch exception
                    enum:
                    - 40o
                    type: string
                type: object
          description: Type Mismatch Exception
        '401':
          content:
            application/json:
              examples:
                Invalid Credentials:
                  summary: Invalid Credentials
                  value:
                    message: Unauthorized
                    status: 401
              schema:
                properties:
                  message:
                    description: Error message
                    type: string
                  status:
                    description: Invalid or missing credentials
                    enum:
                    - '401'
                    type: string
                type: object
          description: Invalid Credentials
        '500':
          content:
            application/json:
              examples:
                Invalid Credentials:
                  summary: Internal Error
                  value:
                    message: Fatal error on handling request
                    status: 500
              schema:
                properties:
                  message:
                    type: string
                  status:
                    type: number
                required:
                - status
                - message
                type: object
          description: Internal Error
      security:
      - BasicAuth: []
      - API_Authorizer: []
      - api_key: []
      summary: List Dynamic Groups
      tags:
      - Uploads
      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/dynamicGroups/{organizationId}
  /dynamicGroups/{organizationId}/{dynamicGroupId}:
    get:
      description: Retrieve the specified dynamic group for an orgnization.
      operationId: EBS Get Dynamic Groups Details
      parameters:
      - description: The ID of the organization containing the upload
        in: path
        name: organizationId
        required: true
        schema:
          $ref: '#/components/schemas/organizationId'
      - description: The ID of the dynamicGroup to return
        in: path
        name: dynamicGroupId
        required: true
        schema:
          example: '2698271864651813'
          type: integer
      responses:
        '200':
          content:
            application/json:
              examples:
                Success:
                  summary: Success
                  value:
                    message: OK
                    result:
                      accountId: 0
                      createdId: 0
                      dirty: false
                      id: 0
                      lastModifiedId: 0
                      lastModifiedTime: 0
                      lastSynchronizedTime: 0
                      organizationId: 0
                      resourceBundleId: 0
              schema:
                properties:
                  message:
                    type: string
                  result:
                    properties:
                      accountId:
                        type: number
                      createdId:
                        type: number
                      dirty:
                        type: boolean
                      id:
                        type: number
                      lastModifiedId:
                        type: number
                      lastModifiedTime:
                        type: number
                      lastSynchronizedTime:
                        type: number
                      organizationId:
                        type: number
                      resourceBundleId:
                        type: number
                    type: object
                type: object
          description: Success
        '400':
          content:
            application/json:
              examples:
                Type Mismatch Exception:
                  summary: Type mismatch exception
                  value:
                    message: type mismatch exception
                    status: 400
              schema:
                properties:
                  message:
                    description: Error message
                    type: string
                  status:
                    description: Type mismatch exception
                    enum:
                    - 40o
                    type: string
                type: object
          description: Type Mismatch Exception
        '401':
          content:
            application/json:
              examples:
                Invalid Credentials:
                  summary: Invalid Credentials
                  value:
                    message: Unauthorized
                    status: 401
              schema:
                properties:
                  message:
                    description: Error message
                    type: string
                  status:
                    description: Invalid or missing credentials
                    enum:
                    - '401'
                    type: string
                type: object
          description: Invalid Credentials
        '500':
          content:
            application/json:
              examples:
                Invalid Credentials:
                  summary: Internal Error
                  value:
                    message: Fatal error on handling request
                    status: 500
              schema:
                properties:
                  message:
                    type: string
                  status:
                    type: number
                required:
                - status
                - message
                type: object
          description: Internal Error
      security:
      - BasicAuth: []
      - API_Authorizer: []
      - api_key: []
      summary: Get Dynamic Groups Details
      tags:
      - Uploads
      x-amazon-apigateway-integration:
        httpMethod: GET
        passthroughBehavior: when_no_match
        requestParameters:
          integration.request.path.dynamicGroupId: method.request.path.dynamicGroupId
          integration.request.path.organizationId: method.request.path.organizationId
        responses:
          default:
            statusCode: '200'
        type: http_proxy
        uri: https://ebs-restapi-prod-us.evbg.io/rest/dynamicGroups/{organizationId}/{dynamicGroupId}
  /dynamicLocations/{organizationId}:
    post:
      description: Upload a CSV with last known location for multiple contacts. <br />Once the file has been uploaded, use [Get DynamicLocation Status](https://developers.everbridge.net/home/reference/ebs-get-dynamic-location-status) to find the status of the upload.
      operationId: EBS Upload Dynamic Locations
      parameters:
      - in: path
        name: organizationId
        required: true
        schema:
          $ref: '#/components/schemas/organizationId'
      - description: Type of upload to perform,; the default is Update
        in: query
        name: uploadBatchType
        required: false
        schema:
          enum:
          - Update
          type: string
      requestBody:
        content:
          multipart/form-data:
            schema:
              properties:
                file:
                  description: A CSV contains dynamic locations to be uploaded.
                  format: binary
                  type: string
              type: object
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                Success:
                  summary: Success
                  value:
                    baseUri: https://api-dev3.everbridge.net/rest/dynamicLocations/1536984111644674
                    id: 2856257941667841
                    instanceUri: https://api-dev3.everbridge.net/rest/dynamicLocations/1536984111644674/2856257941667841
                    message: OK
              schema:
                properties:
                  baseUri:
                    description: API endpoint base URL.
                    type: string
                  id:
                    description: Batch ID of the job created during upload.
                    type: string
                  instanceUri:
                    description: Unique url containing batchID.  This can not be used to return the batch details.  See [Get Contact Upload](https://developers.everbridge.net/home/reference/ebs-get-contact-upload)
                    type: string
                  message:
                    description: Returns status (OK).
                    type: string
                type: object
          description: Accepted
        '400':
          content:
            application/json:
              examples:
                Invalid Request Input:
                  summary: Invalid Input
                  value:
                    message: type mismatch exception
                    status: 400
              schema:
                properties:
                  message:
                    description: Error message
                    type: string
                  status:
                    description: Missing or invalid request input
                    enum:
                    - '400'
                    type: string
                type: object
          description: Invalid request input
        '401':
          content:
            application/json:
              examples:
                Invalid Credentials:
                  summary: Invalid Credentials
                  value:
                    message: Unauthorized
                    status: 401
              schema:
                properties:
                  message:
                    description: Error message
                    type: string
                  status:
                    description: Invalid or missing credentials
                    enum:
                    - '401'
                    type: string
                type: object
          description: Invalid Credentials
        '415':
          content:
            application/json:
              examples:
                Invalid Media Type:
                  summary: Invalid media type
                  value:
                    moreInfoUrl: http media type not supported
                    status: 415
              schema:
                properties:
                  status:
                    description: Invalid media type
                    enum:
                    - '415'
                    type: string
                type: object
          description: Invalid Media Type
        '500':
          content:
            application/json:
              examples:
                Contact Upload Failed:
                  summary: Contact upload failed
                  value:
                    message: Contact upload failed
                    status: 500
              schema:
                properties:
                  message:
                    description: Error message
                    type: string
                  status:
                    description: Contact upload failed
                    enum:
                    - '500'
                    type: string
                type: object
          description: Contact upload Failed
      security:
      - BasicAuth: []
      - API_Authorizer: []
      - api_key: []
      summary: Upload Dynamic Locations
      tags:
      - Uploads
      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/dynamicLocations/{organizationId}
  /dynamicLocations/{organizationId}/{uploadBatchId}:
    get:
      description: Retrieve the specified dynamic locations uploadBatch details.
      operationId: EBS Get Dynamic Locations Details
      parameters:
      - description: The ID of the organization containing the upload
        in: path
        name: organizationId
        required: true
        schema:
          $ref: '#/components/schemas/organizationId'
      - description: The ID of the uploadBatch
        in: path
        name: uploadBatchId
        required: true
        schema:
          example: '2698271864651813'
          type: integer
      responses:
        '200':
          content:
            application/json:
              examples:
                Success:
                  summary: Success
                  value:
                    message: OK
                    result:
                      chunkNum: 0
                      chunking: false
                      createdDate: 1741079194285
                      createdId: 1530249602924607
                      createdName: Vishal Agrawal
                      criticalNum: 1
                      dataCenterId: 0
                      fileName: DynamicLocationsUpload.csv
                      fileSize: 139
                      geoFailNum: 0
                      geoSuccessNum: 0
                      geocodingType: Bing
                      id: 2856257941667841
                      lastModifiedDate: 1741079250050
                      lastModifiedId: 1530249602924607
                      lastModifiedName: Vishal Agrawal
                      organizationId: 1536984111644674
                      resourceBundleId: 0
                      serverId: 83128
                      source: Api
                      successNum: 0
                      uploadStatus: completed
                      withErrorNum: 0
              schema:
                properties:
                  message:
                    type: string
                  result:
                    properties:
                      chunkNum:
                        type: number
                      chunking:
                        type: boolean
                      createdDate:
                        type: number
                      createdId:
                        type: number
                      createdName:
                        type: string
                      criticalNum:
                        type: number
                      dataCenterId:
                        type: number
                      fileName:
                        type: string
                      fileSize:
                        type: number
                      geoFailNum:
                        type: number
                      geoSuccessNum:
                        type: number
                      geocodingType:
                        type: string
                      id:
                        type: number
                      lastModifiedDate:
                        type: number
                      lastModifiedId:
                        type: number
                      lastModifiedName:
                        type: string
                      organizationId:
                        type: number
                      resourceBundleId:
                        type: number
                      serverId:
                        type: number
                      source:
                        type: string
                      successNum:
                        type: number
                      uploadStatus:
                        type: string
                      withErrorNum:
                        type: number
                    type: object
                type: object
          description: Success
        '400':
          content:
            application/json:
              examples:
                Type Mismatch Exception:
                  summary: Type mismatch exception
                  value:
                    message: type mismatch exception
                    status: 400
              schema:
                properties:
                  message:
                    description: Error message
                    type: string
                  status:
                    description: Type mismatch exception
                    enum:
                    - 40o
                    type: string
                type: object
          description: Type Mismatch Exception
        '401':
          content:
            application/json:
              examples:
                Invalid Credentials:
                  summary: Invalid Credentials
                  value:
                    message: Unauthorized
                    status: 401
              schema:
                properties:
                  message:
                    description: Error message
                    type: string
                  status:
                    description: Invalid or missing credentials
                    enum:
                    - '401'
                    type: string
                type: object
          description: Invalid Credentials
        '500':
          content:
            application/json:
              examples:
                Invalid Credentials:
                  summary: Internal Error
                  value:
                    message: Fatal error on handling request
                    status: 500
              schema:
                properties:
                  message:
                    type: string
                  status:
                    type: number
                required:
                - status
                - message
                type: object
          description: Internal Error
      security:
      - BasicAuth: []
      - API_Authorizer: []
      - api_key: []
      summary: Get Upload Dynamic Locations Details
      tags:
      - Uploads
      x-amazon-apigateway-integration:
        httpMethod: GET
        passthroughBehavior: when_no_match
        requestParameters:
          integration.request.path.organizationId: method.request.path.organizationId
          integration.request.path.uploadBatchId: method.request.path.uploadBatchId
        responses:
          default:
            statusCode: '200'
        type: http_proxy
        uri: https://ebs-restapi-prod-us.evbg.io/rest/dynamicLocations/{organizationId}/{uploadBatchId}
  /uploadContacts/{organizationId}/groups/{uploadBatchId}:
    get:
      description: Returns the details of a given contact group upload batch ID.
      operationId: EBS Get Contacts Group Upload Details
      parameters:
      - description: The ID of the organization containing the uploadBatchs
        in: path
        name: organizationId
        required: true
        schema:
          $ref: '#/components/schemas/organizationId'
      - description: The ID of the uploadBatch
        in: path
        name: uploadBatchId
        required: true
        schema:
          example: '2698271864651813'
          type: integer
      - description: Whether to search by LOADED_SUCCESS or LOADED_WITH_ERROR or NOT_LOADED
        in: query
        name: uploadRecordStatus
        required: true
        schema:
          enum:
          - LOADED_SUCCESS
          - LOADED_WITH_ERROR
          - NOT_LOADED
          type: string
      - description: The column name to order
        in: query
        name: columnName
        required: true
        schema:
          enum:
          - externalId
          - uploadErrors
          type: string
      - description: Whether to order by ASC or DESC
        in: query
        name: orderDirection
        schema:
          enum:
          - ASC
          - DESC
          type: string
      - description: The page number of uploadContacts to return
        in: query
        name: pageNumber
        schema:
          default: 1
          type: integer
      responses:
        '200':
          content:
            application/json:
              examples:
                Success:
                  summary: Success
                  value:
                    firstPageUri: https://api-dev3.everbridge.net/rest/uploads/1536984111644674?pageNumber=1
                    lastPageUri: https://api-dev3.everbridge.net/rest/uploads/1536984111644674?pageNumber=7
                    message: OK
                    nextPageUri: https://api-dev3.everbridge.net/rest/uploads/1536984111644674?pageNumber=2
                    page:
                      currentPageNo: 1
                      data:
                      - accountId: 0
                        createdDate: 1741068794230
                        createdId: 2200330536222721
                        createdName: Nandish API Access
                        criticalNum: 0
                        fileName: Contact-Upload-Template.csv
                        fileSize: 105
                        geoFailNum: 0
                        geoSuccessNum: 0
                        headers:
                        - csvColumnName: EBInternalCsvRowNo
                          useful: true
                        - csvColumnName: First Name
                          useful: true
                        - csvColumnName: Last Name
                          useful: true
                        - csvColumnName: External ID
                          useful: true
                        - csvColumnName: Record Type
                          useful: true
                        id: 2853131205476566
                        lastModifiedDate: 1741068794491
                        lastModifiedId: 2200330536222721
                        lastModifiedName: Nandish API Access
                        organizationId: 1536984111644674
                        resourceBundleId: 0
                        source: API
                        status: A
                        successNum: 1
                        uploadMethod: PARTIAL
                        uploadRecordTypes:
                        - recordType: Employee
                          recordTypeId: 1536984111644674
                        uploadStatus: DONE
                        withErrorNum: 0
                      - accountId: 0
                        createdDate: 1741068788134
                        createdId: 2200330536222721
                        createdName: Nandish API Access
                        criticalNum: 0
                        fileName: Contact-Upload-Template.csv
                        fileSize: 105
                        geoFailNum: 0
                        geoSuccessNum: 0
                        headers:
                        - csvColumnName: EBInternalCsvRowNo
                          useful: true
                        - csvColumnName: First Name
                          useful: true
                        - csvColumnName: Last Name
                          useful: true
                        - csvColumnName: External ID
                          useful: true
                        - csvColumnName: Record Type
                          useful: true
                        id: 2853131205476565
                        lastModifiedDate: 1741068788443
                        lastModifiedId: 2200330536222721
                        lastModifiedName: Nandish API Access
                        organizationId: 1536984111644674
                        resourceBundleId: 0
                        source: API
                        status: A
                        successNum: 1
                        uploadMethod: DELETE
                        uploadStatus: DONE
                        withErrorNum: 0
                      pageSize: 10
                      start: 0
                      totalCount: 3
                      totalPageCount: 7
              schema:
                properties:
                  firstPageUri:
                    type: string
                  lastPageUri:
                    type: string
                  message:
                    type: string
                  nextPageUri:
                    type: string
                  page:
                    properties:
                      currentPageNo:
                        type: number
                      data:
                        items:
                          properties:
                            accountId:
                              type: number
                            createdDate:
                              type: number
                            createdId:
                              type: number
                            createdName:
                              type: string
                            criticalNum:
                              type: number
                            fileName:
                              type: string
                            fileSize:
                              type: number
                            geoFailNum:
                              type: number
                            geoSuccessNum:
                              type: number
                            headers:
                              items:
                                properties:
                                  csvColumnName:
                                    type: string
                                  useful:
                                    type: boolean
                                required:
                                - csvColumnName
                                - useful
                                type: object
                              type: array
                            id:
                              type: number
                            lastModifiedDate:
                              type: number
                            lastModifiedId:
                              type: number
                            lastModifiedName:
                              type: string
                            organizationId:
                              type: number
                            resourceBundleId:
                              type: number
                            source:
                              type: string
                            status:
                              type: string
                            successNum:
                              type: number
                            uploadMethod:
                              type: string
                            uploadRecordTypes:
                              items:
                                properties:
                                  recordType:
                                    type: string
                                  recordTypeId:
                                    type: number
                                required:
                                - recordTypeId
                                - recordType
                                type: object
                              type: array
                            uploadStatus:
                              type: string
                            withErrorNum:
                              type: number
                          required:
                          - headers
                          - accountId
                          - organizationId
                          - geoSuccessNum
                          - fileSize
                          - id
                          - uploadMethod
                          - createdDate
                          - createdName
                          - geoFailNum
                          - status
                          - withErrorNum
                          - uploadStatus
                          - resourceBundleId
                          - criticalNum
                          - source
                          - successNum
                          - fileName
                          - createdId
                          - lastModifiedId
                          - lastModifiedDate
                          - lastModifiedName
                          type: object
                        type: array
                      pageSize:
                        type: number
                      start:
                        type: number
                      totalCount:
                        type: number
                      totalPageCount:
                        type: number
                    required:
                    - pageSize
                    - start
                    - data
                    - totalCount
                    - totalPageCount
                    - currentPageNo
                    type: object
                required:
                - message
                - firstPageUri
                - nextPageUri
                - lastPageUri
                - page
                type: object
          description: Success
        '400':
          content:
            application/json:
              examples:
                Type Mismatch Exception:
                  summary: Type mismatch exception
                  value:
                    message: type mismatch exception
                    status: 400
              schema:
                properties:
                  message:
                    description: Error message
                    type: string
                  status:
                 

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