Groups

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

Groups

Group Fields

Parameter	Data Type	Description
name	string	The name of the group.
parentId	long	The ID of the parent group. This value is -1 if there is no parent.
id	long	This is the internal ID for a group.
createId	long	The ID of the user who created this resource.
lastModifiedDate	long	Unix epoch data/time when the contact was last modified.
lastModified	long	The internal ID of the user that last modified this contact.
lastModifiedName	string	First and last name of the user that last modified this contact.
lastSynchronizedTime	long	The date time of last refreshing map layer data.
accountId	long	The ID of the account that owns this resource.
resourceBundleId	long	The ID of the Role which owns this resource.
organizationId	long	The ID of the Organization that owns this resource.
enableSequenceContact	boolean	Whether sequenced has been enabled for a group or not.
dirty	boolean	Whether the contacts of this group have been updated and need to refresh map layer data.

Error Status Codes

HTTP Status Code	Reason
400	Missing or Invalid request input.
401	Invalid or missing credentials.
404	Non-existing name or non-existing ID.
500	Internal Error

GET /groups/{organizationId}

Description

Return a paged set of groups for an organization.

Return type

group Object

Parameters

Name	Data Type	Required?	Description
credentials	string	y	Basic Authorization header.
organizationId	long	y	The ID of the organization containing the groups.

Example Response

{
  "message": "OK",
  "firstPageUri": "https://api.everbridge.net/rest/groups/organizationId/?pageNumber=1",
  "lastPageUri": "https://api.everbridge.net/rest/groups/organizationId/?pageNumber=1",
  "page": {
    "pageSize": 2,
    "start": 0,
    "data": [
      {
        "lastModifiedTime": 0,
        "accountId": 0,
        "resourceBundleId": 0,
        "organizationId": 0,
        "id": 2643234543111210,
        "parentId": -1,
        "name": "Executive",
        "lastModifiedDate": 1467836647752,
        "lastModifiedId": 0,
        "createdId": 0,
        "lastSynchronizedTime": 0,
        "lastModifiedName": "Jennifer Markman",
        "dirty": true
      },
      {
        "lastModifiedTime": 0,
        "accountId": 0,
        "resourceBundleId": 0,
        "organizationId": 0,
        "id": 444211287561988,
        "parentId": -1,
        "name": "Sequenced Group",
        "lastModifiedDate": 1456762515110,
        "lastModifiedId": 0,
        "createdId": 0,
        "lastSynchronizedTime": 0,
        "lastModifiedName": "Anne Eliasan",
        "dirty": true
      }
    ],
    "totalCount": 2,
    "totalPageCount": 1,
    "currentPageNo": 1
  }
}

POST /groups/{organizationId}

Description

Create a new group.

Return type

group Object

Parameters

Name	Data Type	Required?	Description
credentials	string	y	Basic Authorization header.
organizationId	long	y	The ID of the organization containing the groups.
group	groupWrapper	y	The JSON object describing the new group If the group is at the root, the “parentID” is set to -1. If the group is nested, then the “parentID” is the identifier for the parent group.

Request Body

Field	Data Type	Notes
name	string (80)	The name of the group.
parentId	long	Optional : the parentId of the group to be created.

Group without Parent

{
  "name": "API Created Group"
}

Group with Parent

{
  "parentId": 884015938670971,
  "name": "API Created Group"
}

Example Response

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

GET /groups/{organizationId}/{queryValue}

Description

Return a specific group.

Return type

group Object

Parameters

Name	Data Type	Required?	Description
credentials	string	y	Basic Authorization header.
organizationId	long	y	The ID of the organization in which to find the group.
queryValue	string	y	The ID or the name of this group.
queryType	string	y	Whether to search by group.id or group.name.

Example Response

{
  "message": "OK",
  "result": {
    "createdName": "Lucas Herman",
    "lastModifiedTime": 1500929790072,
    "accountId": 0,
    "status": "A",
    "resourceBundleId": 0,
    "organizationId": 453003085611516,
    "id": 444211287561988,
    "parentId": -1,
    "name": "Sequenced Group",
    "lastModifiedDate": 1456762515110,
    "lastModifiedId": 453003085611520,
    "createdId": 453003085611520,
    "createdDate": 1450132608993,
    "lastSynchronizedTime": 1500929790072,
    "lastModifiedName": "Lucas Herman",
    "dirty": false
  }
}

PUT /groups/{organizationId}/{groupId}

Description

Update a group within an organization. “Update” refers to renaming
the group or changing its position.

If the group is nested, then make it a root group by changing the
“parentID” value to -1.

You can change the group position by setting its “parentID” to that
of another parent.

Return type

group Object

Parameters

Name	Data Type	Required?	Description
credentials	string	y	Basic Authorization header.
organizationId	long	y	The ID of the organization containing the groups.
groupId	long	y	The ID of the group to update.
group	groupWrapper	y	The JSON object describing the new group

Request Body

Field	Data Type	Notes
name	string (80)	The name of the group.
parentId	long	Optional : the parentId of the group to be created.

Group without Parent

{
  "name": "API Created Group"
}

Group with Parent

{
  "parentId": 884015938670971,
  "name": "API Created Group"
}

Example Response

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

DELETE /groups/{organizationId}/{groupId}

Description

Delete the specified group from an organization.

Return type

group Object

Parameters

Name	Data Type	Required?	Description
credentials	string	y	Basic Authorization header.
organizationId	long	y	The ID of the organization containing the groups.
groupId	long	y	The ID of the group to delete.

Example Response

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

POST /groups/{organizationId}/contacts

Description

Add many contacts within a group.

Return type

group Object

Parameters

Name	Data Type	Required?	Description
credentials	string	y	Basic Authorization header.
organizationId	long	y	The ID of the organization containing the groups.
byType	string	n	Whether to select by ID or name.
groupId	long	n	The ID of the group to add.
groupName	string	n	The name of the group to add.
idType	string	n	Whether to add by contact.id or contact.externalId.
contactIds	string	y	The JSON object describing the contact IDs.

Example Request

[
  "contact ID 1",
  "contact ID 2",
  "contact ID N"
]

Example Response

{
  "message": "OK",
  "code": 100
}

DELETE /groups/{organizationId}/contacts

Description

Delete many contacts within a group.

Return type

group Object

Parameters

Name	Data Type	Required?	Description
credentials	string	y	Basic Authorization header.
organizationId	long	y	The ID of the organization from which to delete contacts within this group.
byType	string	n	Whether to delete by ID or name of group.
groupId	long	n	The ID of the group to add.
groupName	string	n	The name of the group.
idType	string	n	Whether to delete by contact.id or contact.externalId.
contactIds	string	y	The JSON object describing the contact IDs.

Example Request

[
  "contact ID 1",
  "contact ID 2",
  "contact ID N"
]

Example Response

{
  "message": "OK",
  "code": 100
}

POST /groups/{organizationId}/contacts/sequence

Description

Replace contacts into a sequenced group. The contacts should be a full list, they
will replace the contacts in the group, and the order will be the sequence number of the contact in that
group.

This API does two things: replaces contacts for the group and specifies the
contact sequence.

Return type

batch

Parameters

Name	Data Type	Required?	Description
credentials	string	y	Basic Authorization header.
organizationId	long	y	The ID of the organization containing the groups.
byType	string	n	Whether to select by ID or name.
groupId	long	n	The ID of the group to add.
groupName	string	n	The name of the group to add.
idType	string	n	Whether to add by contact.id or contact.externalId. The default value is ID.
contactIds	string	y	The JSON object describing the contact IDs.

Example Request

[
  "contact ID 1",
  "contact ID 2",
  "contact ID N"
]

Example Response

{
  "message": "OK",
  "code": 100,
  "data": [
    "{\"id\":\"\",\"externalId\":\"[email protected]\",\"result\":\"success\"}"
  ]
}