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 Contact Builder APIs API

The Contact Builder APIs API from Everbridge — 7 operation(s) for contact builder apis.

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

Tagged areas include Contact Builder APIs. 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 8 operations across 7 paths, and defines 49 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against a single base URL, https://api.everbridge.net/managerapps/communications/v1.

8 operations 7 paths 49 schemas 4 GET3 POST1 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, API Key
Resource Areas
1

Authentication & Security 2

Everbridge Contact Builder APIs API declares 2 security schemes for authenticating requests. An API key is passed in the header as Authorization (API_Authorizer). An API key is passed in the header as x-api-key (api_key).

Paths & Operations 8

Across 7 paths, the API surfaces 8 operations — 4 GET, 3 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Contact Builder APIs 8
POST
/contact-builder/from-csv
Upload a CSV of External IDs and get parsing results
contactsFromCsv body → 200400401500
POST
/contact-builder
Start a New Session
startNewSession body → 201400401500
GET
/contact-builder/{sessionId}
Retrieve the Current Session
getSession 1 param → 200401404500
PUT
/contact-builder/{sessionId}
Modify an Existing Session
modifySession 3 params body → 202400401404409500
GET
/contact-builder/{sessionId}/query
Retrieve the Queries for a Session
getQuery 1 param → 200401404409500
GET
/contact-builder/{sessionId}/summary
Retrieve the Summary of Contact Totals for a Session
getSummary 1 param → 200401404409500
GET
/contact-builder/{sessionId}/preview
Retrieve the Individual Contacts for a Session
getContactPreview 12 params → 200401404409500
POST
/contact-builder/{sessionId}/result
End Session
endSession 1 param → 201202400401404500

Schemas 49

The contract defines 49 schemas that model the data the API accepts and returns. The most detailed are SemanticQuery (18 properties), SummarySubsetCounts (8 properties), ContactsFromCsvResult (8 properties), ResultResponse (8 properties). Each schema is shown below with its type and property counts.

ContactsFromCsvResult
object
8 properties 6 required
QueryResponseBucket
array
RuleBucketData
object
Data to be stored in a bucket that supports contact rules (filters).
1 property
SummaryCounts
object
A summary of the number of contacts within each bucket in a session. A bucket may not be present if it has no contacts.
4 properties 2 required
Contact
object
6 properties 3 required
ContactBuilderPreviewResponse
ApiQuerySemanticQuery
object
Include a set of individual contacts by a CEM Results SemanticQuery.
2 properties 2 required
ApiContactId
object
Include an individual contact by their unique system ID.
2 properties 2 required
ApiGroupId
object
Include a set of individual contacts by their membership in a contact group.
2 properties 2 required
CreateSessionRequest
object
Request body to start a new session.
2 properties
SemanticQuery
object
A query use for generating a CEM Result built with semantic logic
18 properties
QueryResponseItemResultSetId
object
A CEM Results identifier that was previously added to this bucket.
2 properties 2 required
SummarySubsetCounts
object
The counts of individual contact groups, rules (filters), and CEM Result Sets within each bucket.
8 properties
CemResultsStaticLocationType
object
Specifies how to include contacts with static location types in CEM Results.
3 properties 1 required
QueryResponseItemResultSetCommandRecipientsOf
object
A RecipientsOf command for retrieving recipients directly from the notification report log.
4 properties 2 required
ClearBucketsRequest
object
Request body to clear all data from the listed buckets.
1 property 1 required
ModificationRequest
object
Request body to modify an existing session.
1 property 1 required
ApiSession
object
The current session metadata.
6 properties
QueryResponse
object
The CEM Results commands/result set IDs that were generated based on the modifications made to the session.
8 properties
Command
object
1 property 1 required
ApiPublicUserResultSet
object
Include a set of public subscribers by a CEM Results ID (Result Set Identifier).
2 properties 2 required
CemResultsBooleanPropertyQuery
PublicUserBucketData
object
Include a set of public users via subscriptions.
1 property
QueryResponseItemResultSetCommandFixedSet
object
A FixedSet command for basic storage of resolved contacts or public users.
2 properties 2 required
QueryBucketData
object
Data to be stored in a bucket that supports generic queries.
1 property
ApiQueryNotificationReportLog
object
Include a set of individual contacts and/or public users via the report log of an existing notification.
5 properties 2 required
ApiQueryResultSet
object
Include a set of individual contacts by a CEM Results ID (Result Set Identifier).
2 properties 2 required
QueryResponseItemResultSetCommandFilter
object
A Filter command for filtering another result set based on its items' properties.
4 properties 2 required
CemResultsPropertyQuery
object
1 property 1 required
ContactBucketData
object
Data to be stored in a bucket that supports individual contacts.
1 property
QueryResponseItemResultSetCommand
object
The accumulated CEM Results command based on previous modifications to the bucket.
3 properties 3 required
CemResultsLastKnownLocationType
object
Specifies how to include contacts with "Last Known" location types in CEM Results.
2 properties 1 required
CemResultsStringPropertyQuery
ProblemDetail
object
An RFC-7807 compliant model for error details.
5 properties
ApiRuleId
object
Include a set of individual contacts by whether they match a contact rule (filter).
2 properties 2 required
CreateSessionResponse
object
Response body returned after starting a new Contact Builder session.
3 properties 1 required
CemResultsNumberPropertyQuery
SummarySubsetTypes
object
3 properties
BaseApiPaginatedResponse
object
1 property
ApiContactExternalId
object
Include an individual contact by their unique system ID.
2 properties 2 required
ResultResponse
object
An object consisting of key-value pairs where the key is the name of the bucket and the value is zero or more CEM Results IDs generated for that bucket.
8 properties
PublicBucketSummary
object
2 properties
CemResultsTravelLocationType
object
Specifies how to include contacts with travel location types in CEM Results.
5 properties 1 required
BucketData
object
Data to be stored in a bucket.
8 properties
CemResultsExpectedLocationType
object
Specifies how to include contacts with expected location types in CEM Results.
1 property 1 required
GroupBucketData
object
Data to be stored in a bucket that supports contact groups.
1 property
ApiPublicUserSemanticQuery
object
Include a set of public subscribers by a CEM Results SemanticQuery.
2 properties 2 required
CemResultsCompleteName
object
Used to describe a contact's complete name in a CEM Results query.
5 properties 3 required
Geometry
object
A geojson representation of a map shape.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

everbridge-contact-builder-apis-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 Contact Builder APIs 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.