Skip to main content
GET
/
organizations
/
{orgId}
/
events
List EventResponse
curl --request GET \
  --url https://api.m3ter.com/organizations/{orgId}/events \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "9cb46d85-7cb6-4637-80a1-d4ec38e4ab30",
      "eventName": "configuration.commitment.created",
      "eventTime": "2022-10-28T13:54:49.557Z",
      "dtActioned": "2022-10-28T13:56:49.557Z",
      "m3terEvent": {
        "eventData": {
          "newDto": {
            "commitmentFeeDescription": "",
            "endDate": "2024-12-31",
            "billingInterval": 1,
            "orgId": "396d788d-5174-XXXX-9d69-YYYY4671fc33",
            "overageSurchargePercent": 5,
            "overageDescription": "",
            "currency": "USD",
            "id": "480d317e-2030-416b-b64b-c07577c418b4",
            "amountSpent": 0,
            "accountCode": "doetech_premium",
            "amount": 15000,
            "billingOffset": 0,
            "lastModifiedBy": "USER_810e3a43-XXXX-4dab-YYYY-470977405b58",
            "billingPlanId": "0409e75a-8a87-43de-aa58-fc6ec823ce37",
            "version": 1,
            "accountId": "1cf2a754-476c-498c-b05a-7d41abfc404d",
            "dtCreated": "2022-10-28T13:54:48.081781Z",
            "amountPrePaid": 0,
            "productIds": [
              "bec371ef-dbad-4e73-a56a-dadecff2287c"
            ],
            "createdBy": "USER_810e3a43-XXXX-4dab-YYYY-470977405b58",
            "contractId": "68595d6d-261f-496b-bf88-51fc7d2b5ccc",
            "commitmentUsageDescription": "",
            "startDate": "2023-01-01",
            "dtLastModified": "2022-10-28T13:54:48.081781Z"
          }
        }
      }
    }
  ],
  "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 the Organization. The Organization represents your company as a direct customer of our service.

Query Parameters

​
pageSize
integer<int32>

The maximum number of Events to retrieve per page.

Required range: 1 <= x <= 100
​
ids
object[]

List of Event UUIDs to filter the results.

NOTE: cannot be used with other filters.

​
notificationId
string

Notification UUID to filter the results. Returns the Events that have triggered the Notification.

​
accountId
string

The Account ID associated with the Event to filter the results. Returns the Events that have been generated for the Account.

​
eventType
string

The category of Events to filter the results by. Options:

  • Notification
  • IntegrationEvent
  • IngestValidationFailure
  • DataExportJobFailure
​
notificationCode
string

Short code of the Notification to filter the results. Returns the Events that have triggered the Notification.

​
includeActioned
boolean

A Boolean flag indicating whether to return Events that have been actioned.

  • TRUE - include actioned Events.
  • FALSE - exclude actioned Events.
​
nextToken
string

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

​
eventName
string | null
​
resourceId
string | null

Response

Returns list of Events

​
data
object[]
​
nextToken
string