Skip to main content
GET
/
organizations
/
{orgId}
/
events
/
fields
List Events
curl --request GET \
  --url https://api.m3ter.com/organizations/{orgId}/events/fields \
  --header 'Authorization: Bearer <token>'
{
  "events": {
    "configuration.commitment.created": {
      "new.accountCode": "string",
      "new.accountId": "string",
      "new.accountingProductId": "string",
      "new.amount": "double",
      "new.amountFirstBill": "double",
      "new.amountPrePaid": "double",
      "new.amountSpent": "double",
      "new.billEpoch": "string",
      "new.billingInterval": "int",
      "new.billingOffset": "int",
      "new.billingPlanId": "string",
      "new.commitmentFeeBillInAdvance": "boolean",
      "new.commitmentFeeDescription": "string",
      "new.commitmentUsageDescription": "string",
      "new.contractId": "string",
      "new.currency": "string",
      "new.customFields": "map",
      "new.endDate": "string",
      "new.feeDates": "array",
      "new.id": "string",
      "new.overageDescription": "string",
      "new.overageSurchargePercent": "double",
      "new.productIds": "array",
      "new.startDate": "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

​
eventName
string

The name of the specific Event Type to use as a list filter, for example configuration.commitment.created.

Response

Returns the list of Fields for an Event Type

Response containing the list of Fields for an Event Type.

​
events
object

An object containing the list of Fields for the queried Event Type.

See the 200 Response sample where we have queried to get the Fields for the configuration.commitment.created Event Type.

Note: new represents the attributes the newly created object has.