List Notifications - m3ter Documentation

List Notifications

cURL

curl --request GET \
  --url https://api.m3ter.com/organizations/{orgId}/notifications/configurations \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.m3ter.com/organizations/{orgId}/notifications/configurations"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.m3ter.com/organizations/{orgId}/notifications/configurations', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.m3ter.com/organizations/{orgId}/notifications/configurations",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
}

package main

import (
    "fmt"
    "net/http"
    "io"
)

func main() {

url := "https://api.m3ter.com/organizations/{orgId}/notifications/configurations"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("Authorization", "Bearer <token>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
    body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))
}

HttpResponse<String> response = Unirest.get("https://api.m3ter.com/organizations/{orgId}/notifications/configurations")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.m3ter.com/organizations/{orgId}/notifications/configurations")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

Response Status Codes

• 200
• 4XX
• 5XX

Sample Response

{
  "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>"
}

{
  "message": "<string>"
}

Authorization

• Authorization: string (header) required
• m3ter supports machine to machine authentication using the clientCredentials OAuth2 flow.

Path Parameters

• orgId: string (required) - The unique identifier (UUID) of your Organization, representing your company as a direct customer.

Query Parameters

• pageSize: integer - The maximum number of Notifications to retrieve per page. Required range: 1 <= x <= 100
• nextToken: string - For multi-page retrievals.
• active: boolean - A Boolean flag to retrieve either only active or only inactive Notifications.
• eventName: string - Filters Notifications based on the specified Event type.
• ids: object[] - A list of specific Notification UUIDs to retrieve.

Response (200)

• application/json - Returns the list of Event Notifications.

{
  "data": [{}],
  "nextToken": "<string>"
}