Note: This page has not yet been converted to the new developer portal format. Please use Swagger to test this API.
Profile Data Model
The profiles collection is
used for managing the Response Subscription Profiles found on the Settings tab > Everbridge Open >
Response Subscriptions > Profiles.
GET /profiles/{organizationId}
Description
Retrieve all profiles in this organization.
Return type
[collection] of [profiles].
Parameters
| Name | Type | Optional? | Description |
|---|---|---|---|
organizationId | url | n | The ID of the organization containing these profiles. |
sort | query | y | Comma-delimited list of fields by which to sort. +/- can precede the field Name to indicate direction (ascending/descending). + is the default direction. Ex. sort=name,-createdDate sorts by name ascending and createdDate descending. |
pageSize | query | y | The number of records per page to be included in the response. |
pageNo | query | y | The page to be returned. |
GET /profiles/{organizationId}/profileId
Description
Retrieve a Profile by ID within an organization.
Return type
[profile] [instance]
Parameters
| Name | Type | Optional? | Description |
|---|---|---|---|
organizationId | url | n | The ID of the organization containing the profile. |
profileId | url | n | The ID of the Profile. |