Skip to main content
GET
/
organizations
/
{orgId}
/
notifications
/
configurations
List Notifications
curl --request GET \
  --url https://api.m3ter.com/organizations/{orgId}/notifications/configurations \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "name": "Commitment has under 10% remaining",
      "description": "Commitment amount fell below 10%",
      "code": "commitment_under_10_percent",
      "version": 123,
      "dtCreated": "2023-11-07T05:31:56Z",
      "dtLastModified": "2023-11-07T05:31:56Z",
      "createdBy": "<string>",
      "lastModifiedBy": "<string>",
      "active": true,
      "alwaysFireEvent": false,
      "eventName": "configuration.commitment.updated",
      "calculation": "(new.amountSpent >= ((new.amount*90)/100)) \nAND ((old.amountSpent <= ((old.amount*90)/100)) OR (old.amountSpent == null))"
    }
  ],
  "nextToken": "<string>"
}

Authorizations

​
Authorization
string
header
required

m3ter supports machine to machine authentication using the clientCredentials OAuth2 flow.

The authorizationCode flow controls access for human users via the m3ter Console application.

Path Parameters

​
orgId
string
required

The unique identifier (UUID) of your Organization. The Organization represents your company as a direct customer of our service.

Query Parameters

​
pageSize
integer<int32>

Specifies the maximum number of Notifications to retrieve per page.

Required range: 1 <= x <= 100
​
nextToken
string

The nextToken for multi-page retrievals. It is used to fetch the next page of Notifications in a paginated list.

​
active
boolean

A Boolean flag indicating whether to retrieve only active or only inactive Notifications.

  • TRUE - only active Notifications are returned.
  • FALSE - only inactive Notifications are returned.
​
eventName
string

Use this to filter the Notifications returned - only those Notifications that are based on the Event type specified by eventName are returned.

​
ids
object[]

A list of specific Notification UUIDs to retrieve.

Response

Returns the list of Event Notifications

​
data
object[]
​
nextToken
string