How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Everbridge Contacts API

Contacts operations

Everbridge Contacts API is one of 91 APIs that Everbridge publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Contacts. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, and authentication docs.

This API exposes 43 operations across 29 paths, and defines 54 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 3 base URLs: https://api.everbridge.net/digitalapps/v2, https://api.everbridge.net/rest, https://api.everbridge.eu/rest.

43 operations 29 paths 54 schemas 7 DELETE13 GET6 PATCH11 POST6 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://api.everbridge.net/rest
Authentication
API Key, HTTP Basic, API Key
Resource Areas
1

Authentication & Security 3

Everbridge Contacts API declares 3 security schemes for authenticating requests. An API key is passed in the header as Authorization (API_Authorizer). It accepts HTTP basic authentication (BasicAuth). An API key is passed in the header as x-api-key (api_key).

  • BasicAuth — Basic Authentication Token
  • api_key — API Key - For System Use

Paths & Operations 43

Across 29 paths, the API surfaces 43 operations — 7 DELETE, 13 GET, 6 PATCH, 11 POST, 6 PUT. Each is listed below with its method, path, parameters, and response codes.

Contacts 43

Contacts operations

GET
/contacts/me
Get Contact
ebs-daa-get-contact-info 2 params → 200404
GET
/contacts/preferences
Get Contact Preferences
ebs-daa-get-contacts-preferences 2 params → 200
PATCH
/contacts/preferences
Update Contact Preferences
ebs-daa-update-contact-preferences 2 params body → 200
POST
/contacts/devices
Register device
ebs-daa-register-device 2 params body → 200
PATCH
/contacts/devices/{deviceId}
Update Device Token
ebs-daa-update-device-token 3 params body → 200
DELETE
/contacts/devices/{deviceId}
Deregister Device
ebs-daa-deregister-device 3 params → 200
PATCH
/contacts/devices/{deviceId}/reset-badge
Reset Device Badge
ebs-daa-reset-device-badge 3 params → 200
PATCH
/contacts/devices/{deviceId}/enable-push
Enable Push Notification
ebs-daa-enable-push-notification 3 params → 200
PATCH
/contacts/devices/{deviceId}/disable-push
Disable Push Notification
ebs-daa-disable-push-notification 3 params → 200
POST
/contacts/safe-corridors
Create SafeCorridor
ebs-daa-create-safe-corridor 2 params body → 200
GET
/contacts/safe-corridors/active-devices/{device-id}
Get Active SafeCorridor
ebs-daa-get-active-safe-corridor 3 params → 200
PUT
/contacts/safe-corridors/{safe-corridor-id}
Stop SafeCorridor
ebs-daa-stop-safe-corridor 3 params body → 200
POST
/contacts/panics
Create Panic
ebs-daa-create-panic 2 params body → 200
PUT
/contacts/panics/{panic-id}
Update Panic
ebs-daa-update-panic 3 params body → 200
POST
/contacts/checkins
Create Checkin
ebs-daa-create-checkin 2 params body → 200403
DELETE
/contacts/checkins/last
Delete Checkin
ebs-daa-delete-last-checkin 2 params → 200403404
POST
/contacts/emergency-calls
Create Emergency Call
ebs-daa-create-emergency-call 2 params body → 200
POST
/contacts/custom-forms
Create Custom Form
ebs-daa-submit-custom-form 2 params body → 200
DELETE
/contacts/devices/{deviceId}/remote-wipe
Remote Wipe Device
ebs-daa-remote-wipe-device 3 params → 204
GET
/contactAttributes/{organizationId}
List Contact Attributes
EBS List Contact Attributes 1 param → 200400401500
POST
/contactAttributes/{organizationId}
Create Contact Attribute
EBS Create Contact Attribute 1 param body → 200400401500
DELETE
/contactAttributes/{organizationId}/{contactAttributeId}
Delete Contact Attribute
EBS Delete Contact Attribute 2 params → 200400401404500
GET
/contactAttributes/{organizationId}/{contactAttributeId}
Get Contact Attribute
EBS Get Contact Attribute 2 params → 200400401404500
PUT
/contactAttributes/{organizationId}/{contactAttributeId}
Update Contact Attribute
EBS Update Contact Attribute 2 params body → 200400401404500
GET
/contactPaths/{organizationId}
List Contact Paths
EBS List Contact Paths 1 param → 200
GET
/contactPaths/{organizationId}/{contactPathId}
Get Contact Path
EBS Get Contact Path 2 params → 200404
GET
/contacts/groups/{organizationId}
List Group Contacts
EBS List Group Contacts 6 params → 200
GET
/contacts/{organizationId}
List Contacts
EBS List Contacts 13 params body → 200
POST
/contacts/{organizationId}
Create Contact
EBS Create Contact 1 param body → 200
DELETE
/contacts/{organizationId}/batch
Delete Contacts (Batch)
EBS Delete Contacts Batch 2 params body → 200401
POST
/contacts/{organizationId}/batch
Create Contacts (Batch)
EBS Create Contacts Batch 1 param body → 200400
PUT
/contacts/{organizationId}/batch
Update Contacts (Batch)
EBS Update Contacts Batch 3 params body → 200401
POST
/contacts/{organizationId}/query
Query Contacts (Batch)
EBS Query Contacts Batch 1 param body → 200400
DELETE
/contacts/{organizationId}/{id}
Delete Contact
EBS Delete Contact 3 params → 200
GET
/contacts/{organizationId}/{id}
Get Contact
EBS Get Contact 3 params → 200404
PATCH
/contacts/{organizationId}/{id}
Update Contact (Partial)
EBS Update Contact Partial 3 params body → 200400404
PUT
/contacts/{organizationId}/{id}
Update Contact
EBS Update Contact 3 params body → 200404
GET
/locationTypes/{organizationId}
List Location Types
EBS List Location Types 1 param → 200
POST
/locationTypes/{organizationId}
Create Location Type
EBS Create Location Type 1 param body → 200400401404500
DELETE
/locationTypes/{organizationId}/{locationTypeId}
Delete Location Type
EBS Delete Location Type 2 params → 200400401404500
GET
/locationTypes/{organizationId}/{locationTypeId}
Get Location Type
EBS Get Location Type 2 params → 200400401404500
PUT
/locationTypes/{organizationId}/{locationTypeId}
Update Location Type
EBS Update Location Type 2 params body → 200400401404500
GET
/uploadContacts/{organizationId}/getEmailListForSendingNotification
Get Email List For Contact Upload
EBS Get Email List 1 param → 200404

Schemas 54

The contract defines 54 schemas that model the data the API accepts and returns. The most detailed are ContactWrapper (44 properties), getContact (35 properties), contactRequest (25 properties), ContactAddressWrapper (17 properties). Each schema is shown below with its type and property counts.

SafeCorridorV2Request
object
11 properties 2 required
ContactPreference
object
3 properties
GisLocation
object
3 properties
SafeCorridorServerHandledVo
object
4 properties
PanicResponse
object
5 properties
AccountV2Response
object
5 properties 1 required
PanicOperationV2Response
object
3 properties
SafetyV2Response
object
1 property 1 required
CheckinResponse
object
1 property 1 required
CheckinRequest
object
3 properties 2 required
PanicV2Request
object
11 properties 2 required
PanicOperationV2Request
object
3 properties 1 required
StopSafeCorridorV2Request
object
5 properties 2 required
DeviceRequest
object
2 properties 2 required
ButtonSubmitFormEvent
object
16 properties
EmergencyCallV2Request
object
9 properties 2 required
FormItem
object
3 properties
DeviceResponse
object
1 property 1 required
MemberAccountSetting
object
8 properties
postUpdateResponse
object
4 properties
UpdateContactBatchRequest
array
error
object
2 properties 2 required
ContactPathWrapper
object
11 properties
ContactBatchResponse
object
2 properties
getContacts
object
2 properties
CreateContactBatchRequest
array
ContactQueryParam
object
Query conditions
13 properties
badPatchResponse
object
3 properties
ContactWrapperCollectionResult
object
7 properties
GisLocationWrapper
object
2 properties
contactPath
object
2 properties
getContact
object
35 properties
ContactSearchConditionWrapper
object
7 properties
ContactWrapper
object
44 properties
locationTypeSingleResponseWrapper
object
14 properties 11 required
contactAttributesRequest
object
8 properties 4 required
contactRequest
object
25 properties 3 required
ContactAddressWrapper
object
17 properties 5 required
locationTypeCreateRequestWrapper
object
2 properties 2 required
ContactAttributeWrapper
object
3 properties
ContactFilterRuleWrapper
object
16 properties
GeoPointWrapper
object
2 properties
patchEntity
object
3 properties 2 required
patchRequest
array
TimeFrameWrapper
object
6 properties
DeleteContactBatchRequest
array
GeoShapeWrapper
object
1 property
locationTypeUpdateRequestWrapper
object
2 properties 1 required
locationTypeListResponseWrapper
object
4 properties 4 required
contactAttributesResponse
object
4 properties
SearchShapeWrapper
object
8 properties
organizationId
integer
Everbridge Organization id. Available on manager portal (Settings -- Organization -- Base Information)
DataPageContactWrapper
object
8 properties
contactPaths
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

everbridge-contacts-api-openapi.yml Raw ↑

Other APIs Everbridge publishes across the network.

Everbridge iPaaS API
Everbridge Asset Association Definition API
Everbridge Asset License Limit Stats API
Everbridge Asset Type Templates API
Everbridge Asset Types API
Everbridge Asset Upload Batches API
Everbridge Assets API
Everbridge Assets Batch API
Everbridge Assets Query API
Everbridge Attachments API
Everbridge Audio API
Everbridge Audit Log API
Where this information came from

This is an independent, third-party profile of Everbridge Contacts API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.