Note: This page has not yet been converted to the new developer portal format. Please use Swagger to test this API.

Contact Filters

Contact Filter Fields

Field	Data Type (Length)	Required?	Read Only	Notes
id	long	n	x	The internal ID for a contact filter. It is visible on the URI in the UI.
name	string (100)	y		The name of the filter.
contactFilterType	string	n		Constant ContactRule.
contactFilterRules	contactFilterRule[]	y		An array of contactFilterrules.
createdDate	long	n	x	Unix epoch date/time when the filter was created.
createdId	long	n	x	Internal ID of the user that created this filter.
createdName	string	n	x	First and last name of the user that created this filter.
lastModifiedDate	long	n	x	Unix epoch date/time when the filter was last modified.
lastModifiedId	long	n	x	The internal ID of the user that last modified this filter.
lastModifiedName	string	n	x	The first and last name of the user that last modified this filter.
lastModifiedTime	long	n	x	Unix epoch date/time when the filter was last modified.
lastSynchronizedTime	long	n	x	Unix epoch date/time when the filter was last synchronized.
accountId	long	n	x	The ID of the account that owns this resource.
status	string	n	x	The status of the object. All records returned by the API should have a status of 'A' indicating that the record is active and has not been deleted. Deleted records of any type are invisible to the API.
resourceBundleId	long	n	x	The ID of the Role which owns this resource.
organizationId	long	n	x	The ID of the organization to which this filter belongs.
dirty	boolean	n	x	Whether the contacts of this group have been updated and need to refresh map layer data.

Contact Filter Rule Fields

Name	Data Type (Length)	Required?	Description
id	long	x	The internal ID for a contact.
contactFieldId	long		Required if type is SYSTEM, SYSTEM_OBJECT or SYSTEM_ARRAY
columnName	string		Required if type is SYSTEM, SYSTEM_OBJECT or SYSTEM_ARRAY
columnValue	Depends on field type (string, date, number)		Required if type is SYSTEM, SYSTEM_OBJECT or SYSTEM_ARRAY
attributeId	long		Required if type is CUSTOM or CUSTOM_ARRAY
attributeValues	string[]		The values the filter is looking for. Required if type is CUSTOM or CUSTOM_ARRAY
type	string		One of: ◊ SYSTEM ◊ CUSTOM ◊ SYSTEM_OBJECT ◊ SYSTEM_ARRAY ◊ CUSTOM_ARRAY ◊ SYSTEM_SCHEDULING ◊ SYSTEM_EXPECTED_OBJECT
dataType	string		One of: ◊ STRING ◊ NUMBER ◊ DATE ◊ BOOLEAN
operator	string		String ◊ STARTWITH ◊ ENDWITH (ends with) ◊ E (equal to) ◊ NE (not equal to) ◊ LIKE (contains) ◊ NLIKE (does not contain) ◊ GT (greater than) ◊ LT (less than) ◊ GTE (greater than or equal to) ◊ LTE (less than or equal to) Number ◊ E (equal to) ◊ NE (not equal to) ◊ GT (greater than) ◊ LT (less than) ◊ GTE (greater than or equal to) ◊ LTE (less than or equal to) Date field ◊ E (equal to) ◊ LT (is before) ◊ LTE (is equal to or before) ◊ GT (is after) ◊ GTE (is equal to or after) ◊ BETWEEN (between two dates) Single select list ◊ E (equal to) ◊ NE (not equal to) Multiple choice list ◊ IN (contains) ◊ NIN (does not contain)
contactFilteroption	string		Same as operator

Details below:

columnName	dataType	type	operator	embeddedColumnName
firstName	STRING	SYSTEM	STARTWITH,ENDWITH,E,NE,LIKE,NLIKE
lastName	STRING	SYSTEM	STARTWITH,ENDWITH,E,NE,LIKE,NLIKE
middleInitial	STRING	SYSTEM	STARTWITH,ENDWITH,E,NE,LIKE,NLIKE
suffix	STRING	SYSTEM	STARTWITH,ENDWITH,E,NE,LIKE,NLIKE
externalId	STRING	SYSTEM	STARTWITH,ENDWITH,E,NE,LIKE,NLIKE
country	STRING	SYSTEM	STARTWITH,ENDWITH,E,NE,LIKE,NLIKE
recordTypeId	NUMBER	SYSTEM	E,NE,LT,LTE,GT,GTE
userId	NUMBER	SYSTEM	ISNULL,NOTNULL
individualAccountId	NUMBER	SYSTEM	ISNULL,NOTNULL
lastModifiedDate	DATE	SYSTEM	BETWEEN,LT,LTE,GT,GTE
lastModifiedName	STRING	SYSTEM	STARTWITH,ENDWITH,E,NE,LIKE,NLIKE
registedEmail	STRING	SYSTEM	STARTWITH,ENDWITH,E,NE,LIKE,NLIKE
registedDate	DATE	SYSTEM	BETWEEN,LT,LTE,GT,GTE
groups	NUMBER	SYSTEM_ARRAY	IN,NIN
value	STRING	SYSTEM_OBJECT	STARTWITH,ENDWITH,E,NE,LIKE,NLIKE	paths
locationName	STRING	SYSTEM_OBJECT	STARTWITH,ENDWITH,E,NE,LIKE,NLIKE	address
streetAddress	STRING	SYSTEM_OBJECT	STARTWITH,ENDWITH,E,NE,LIKE,NLIKE	address
suite	STRING	SYSTEM_OBJECT	STARTWITH,ENDWITH,E,NE,LIKE,NLIKE	address
city	STRING	SYSTEM_OBJECT	STARTWITH,ENDWITH,E,NE,LIKE,NLIKE	address
state	STRING	SYSTEM_OBJECT	STARTWITH,ENDWITH,E,NE,LIKE,NLIKE	address
postalCode	STRING	SYSTEM_OBJECT	STARTWITH,ENDWITH,E,NE,LIKE,NLIKE	address
country	STRING	SYSTEM_OBJECT	STARTWITH,ENDWITH,E,NE,LIKE,NLIKE	address
address.gisLocation.lon	NUMBER	SYSTEM	ISNULL,NOTNULL
addressGeoCodingSource	STRING	SYSTEM_OBJECT	IN,NIN	address
locationId	NUMBER	SYSTEM_OBJECT	E,NE,LT,LTE,GT,GTE
floorNo	STRING	SYSTEM_OBJECT	STARTWITH,ENDWITH,E,NE,LIKE,NLIKE	address
floorNo	STRING	SYSTEM_OBJECT	STARTWITH,ENDWITH,E,NE,LIKE,NLIKE	lastKnownLocation
address.streetAddress	BOOLEAN	SYSTEM	ISNULL,NOTNULL
gisLocation.lat	NUMBER	SYSTEM_OBJECT	E,NE,LT,LTE,GT,GTE	address
gislocation.lon	NUMBER	SYSTEM_OBJECT	E,NE,LT,LTE,GT,GTE	address
pathId	NUMBER	SYSTEM_OBJECT	IN,NIN	paths
createdDate	DATE	SYSTEM	BETWEEN,LT,LTE,GT,GTE
topics	NUMBER	SYSTEM	IN,NIN
systemRequirement	STRING	SYSTEM_OBJECT	STARTWITH,ENDWITH,E,NE,LIKE,NLIKE	paths
calendar	NUMBER	SYSTEM_SCHEDULING	E
shift	NUMBER	SYSTEM_SCHEDULING	E
shiftDate	DATE*	SYSTEM_SCHEDULING	BETWEEN
ssoIdentity	STRING	SYSTEM	STARTWITH,ENDWITH,E,NE,LIKE,NLIKE
smUserId	NUMBER	SYSTEM	ISNULL,NOTNULL
expectedDate	DATE*	SYSTEM_EXPECTED_OBJECT	BETWEEN,LT,LTE,GT,GTE, BETWEEN
locationName	STRING	SYSTEM_EXPECTED_OBJECT	STARTWITH,ENDWITH,E,NE,LIKE,NLIKE	address
city	STRING	SYSTEM_EXPECTED_OBJECT	STARTWITH,ENDWITH,E,NE,LIKE,NLIKE	address
state	STRING	SYSTEM_EXPECTED_OBJECT	STARTWITH,ENDWITH,E,NE,LIKE,NLIKE	address
country	STRING	SYSTEM_EXPECTED_OBJECT	STARTWITH,ENDWITH,E,NE,LIKE,NLIKE	address
iata	STRING	SYSTEM_EXPECTED_OBJECT	STARTWITH,ENDWITH,E,NE,LIKE,NLIKE	address
locationId	STRING	SYSTEM_EXPECTED_OBJECT	E,NE,LT,LTE,GT,GTE	address

NOTE: columnValue(except sxpectedDate, shiftDate) depends on operator, if it is IN, NIN, BETWEEN, columnValue should be an array, otherwise as data type indicates.
expectedDate and shiftDate are special. Their value should be an array with three elements, and there are only two patterns: ["NOW",null,null] or ["BETWEEN", fromDate, toDate].

GET /contactFilters/{organizationId}

Description

Retrieve multiple contact filters.

Return type

contactFilter Object

Parameters

Name	Data Type	Required?	Description
credentials	string	y	Basic Authorization header.
organizationId	long	y	The ID of the organization containing the contacts.
pageNumber	int	y	The page number of results to retrieve. Default is 1.

{
    "message": "OK",
    "firstPageUri": "https://api.everbridge.net/rest/contactFilters/892807736728255/?pageNumber=1",
    "nextPageUri": "https://api.everbridge.net/rest/contactFilters/{organizationId}/?pageNumber=2",
    "lastPageUri": "https://api.everbridge.net/rest/contactFilters/892807736728255/?pageNumber=1",
    "page": {
        "pageSize": 20,
        "start": 0,
        "data": [
            {
                "lastModifiedTime": 0,
                "accountId": 0,
                "resourceBundleId": 892807736730016,
                "contactFilterType": "ContactRule",
                "organizationId": 0,
                "id": 2457979718729733,
                "name": "Test calendar",
                "lastModifiedDate": 1650549036871,
                "lastModifiedId": 0,
                "createdId": 0,
                "lastSynchronizedTime": 0,
                "lastModifiedName": "Paulomi Mahidharia",
                "contactFilterRules": [
                    {
                        "contactFieldId": 200,
                        "type": "SYSTEM_SCHEDULING",
                        "operator": "E",
                        "dataType": "NUMBER",
                        "columnName": "calendar",
                        "contactFilterOption": "E",
                        "columnValue": 2457962538860545
                    },
                    {
                        "contactFieldId": 201,
                        "type": "SYSTEM_SCHEDULING",
                        "operator": "E",
                        "dataType": "NUMBER",
                        "columnName": "shift",
                        "contactFilterOption": "E",
                        "columnValue": 0
                    },
                    {
                        "contactFieldId": 202,
                        "type": "SYSTEM_SCHEDULING",
                        "operator": "BETWEEN",
                        "dataType": "DATE",
                        "columnName": "shiftDate",
                        "contactFilterOption": "BETWEEN",
                        "columnValue": [
                            "NOW",
                            null,
                            null
                        ]
                    }
                ],
                "dirty": true
            }
        ],
        "totalCount": 4,
        "totalPageCount": 1,
        "currentPageNo": 1
    }
}

POST /contactFilters/{organizationId}

Description

Create a new contactFilter within an organization.

Return type

contactFilter Object

Parameters

Name	Data Type	Required?	Description
credentials	string	y	Basic Authorization header.
organizationId	long	y	The ID of the organization containing the contacts.
contactFilter	contactFilterWrapper	y	The JSON object describing the new contactFilter.

Example Request Body

{
  "name": "DBAs",
  "contactFilterRules": [
    {
      "attributeId": 3549227829428287,
      "type": "CUSTOM",
      "operator": "LIKE",
      "dataType": "STRING",
      "attributeValues": [
        "DBA"
      ],
      "contactFilterOption": "LIKE"
    },
    {
      "contactFieldId": 1,
      "type": "SYSTEM",
      "operator": "NLIKE",
      "dataType": "STRING",
      "columnName": "firstName",
      "contactFilterOption": "NLIKE",
      "columnValue": "Mike"
    }
  ]
}

Example Returns

{
  "message": "OK",
  "id": "{the internal id of the record just created}",
  "baseUri": "https://api.everbridge.net/rest/contactFilters/{organizationId}/",
  "instanceUri": "https://api.everbridge.net/rest/contactFilters/{organizationId}/{contactFilterId}"
}

GET /contactFilters/{organizationId}/{queryValue}

Description

Retrieve the specified contactFilter within an organization.

Return type

contactFilter Object

Parameters

Name	Data Type	Required?	Description
credentials	string	y	Basic Authorization header.
organizationId	long	y	The ID of the organization containing the contacts.
queryValue	string	y	The ID or name of the contactFilter.
queryType	string	y	Whether to search by contactFilter.id or contactFilter.Name.

POST /contactFilters/{organizationId}/{contactFilterId}

Description

Retrieve a single contactFilter.

Parameters

None

Returns

{
  "id": 3083039194221618,
  "name": "Applications Primary On Call",
  "contactFilterType": "ContactRule",
  "contactFilterRules": [
    {
      "contactFieldId": 200,
      "type": "SYSTEM_SCHEDULING",
      "operator": "E",
      "dataType": "NUMBER",
      "columnName": "calendar",
      "contactFilterOption": "E",
      "columnValue": 3083034899251300
    },
    {
      "contactFieldId": 201,
      "type": "SYSTEM_SCHEDULING",
      "operator": "E",
      "dataType": "NUMBER",
      "columnName": "shift",
      "contactFilterOption": "E",
      "columnValue": 3083034899251335
    },
    {
      "contactFieldId": 202,
      "type": "SYSTEM_SCHEDULING",
      "operator": "BETWEEN",
      "dataType": "DATE",
      "columnName": "shiftDate",
      "contactFilterOption": "BETWEEN",
      "columnValue": [
        "NOW",
        null,
        null
      ]
    }
  ],
  "createdDate": 1407517981481,
  "createdId": 892807736721858,
  "createdName": "Mike Wallick",
  "lastModifiedDate": 1407518281577,
  "lastModifiedId": 892807736721858,
  "lastModifiedName": "Mike Wallick",
  "lastModifiedTime": 0,
  "lastSynchronizedTime": 0,
  "accountId": 1772417038942236,
  "status": "A",
  "resourceBundleId": 892807736721838,
  "organizationId": 892807736721854,
  "dirty": true
}

PUT /contactFilters/{organizationId}/{contactFilterId}

Description

Update a contactFilter within an organization.

Return type

contactFilter Object

Parameters

None

Example Request Body

The request body is identical to the POST method.

Example Returns

{
  "message": "OK",
  "id": "{the internal id of the record just updated}",
  "baseUri": "https://api.everbridge.net/rest/contactFilters/{organizationId}/",
  "instanceUri": "https://api.everbridge.net/rest/contactFilters/{organizationId}/{contactFilterId}"
}

DELETE /contactFilters/{organizationId}/{contactFilterId}

Description

Delete the specified contactFilter from an organization.

Return type

contactFilter Object

Parameters

Name	Data Type	Required?	Description
credentials	string	y	Basic Authorization header.
organizationId	long	y	The ID of the organization containing the contactFilters.
contactFilterId	long	y	The ID or name of the contactFilter to delete.

Example Request Body

None

Example Returns

{
  "message": "OK",
  "id": "{the internal id of the record just deleted}",
  "baseUri": "https://api.everbridge.net/rest/contactFilters/{organizationId}/",
  "instanceUri": "https://api.everbridge.net/rest/contactFilters/{organizationId}/{contactFilterId}"
}