Skip to main content
GET
/
organizations
/
{orgId}
/
dataexports
/
jobs
List Jobs
curl --request GET \
  --url https://api.m3ter.com/organizations/{orgId}/dataexports/jobs \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "version": 123,
      "scheduleId": "<string>",
      "startedAt": "2023-11-07T05:31:56Z",
      "dateCreated": "2023-11-07T05:31:56Z",
      "sourceType": "USAGE",
      "status": "PENDING"
    }
  ],
  "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

​
ids
string

List Job entities for the given UUIDs

​
scheduleId
string

List Job entities for the schedule UUID

​
status
enum<string>

List Job entities for the status

Available options:
PENDING,
RUNNING,
SUCCEEDED,
FAILED
​
dateCreatedStart
string

Include only Job entities created on or after this date. Format: yyyy-MM-dd'T'HH:mm:ss'Z'

​
dateCreatedEnd
string

Include only Job entities created before this date. Format: yyyy-MM-dd'T'HH:mm:ss'Z'

​
pageSize
integer<int32>

Number of Jobs to retrieve per page

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

nextToken for multi page retrievals

Response

Returns a list Export Job entities

​
data
object[]
​
nextToken
string