Skip to main content
GET
/
organizations
/
{orgId}
/
dataexports
/
schedules
List Schedules
curl --request GET \
  --url https://api.m3ter.com/organizations/{orgId}/dataexports/schedules \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "version": 123,
      "name": "<string>",
      "code": "<string>",
      "sourceType": "USAGE",
      "destinationIds": [
        "<string>"
      ],
      "scheduleType": "HOUR",
      "period": 123,
      "offset": 123,
      "cronExpression": "<string>",
      "exportFileFormat": "CSV",
      "dtCreated": "2023-11-07T05:31:56Z",
      "dtLastModified": "2023-11-07T05:31:56Z",
      "createdBy": "<string>",
      "lastModifiedBy": "<string>"
    }
  ],
  "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

UUID of the organization

Query Parameters

​
pageSize
integer<int32>

Number of schedules to retrieve per page

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

nextToken for multi page retrievals

​
ids
object[]

Data Export Schedule IDs to filter the returned list by.

Response

Returns a list of Export Schedules.

​
data
object[]
​
nextToken
string