Skip to main content
GET
/
organizations
/
{orgId}
/
statementjobs
List Statement Jobs
curl --request GET \
  --url https://api.m3ter.com/organizations/{orgId}/statementjobs \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "version": 123,
      "statementJobStatus": "PENDING",
      "billId": "<string>",
      "orgId": "<string>",
      "includeCsvFormat": true,
      "filters": {
        "meterIds": "<string>"
      },
      "presignedJsonStatementUrl": "<string>",
      "jsonStatementStatus": "LATEST",
      "presignedCsvStatementUrl": "<string>",
      "csvStatementStatus": "LATEST",
      "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

The unique identifier (UUID) of your Organization. The Organization represents your company as a direct customer of our service.

Query Parameters

​
pageSize
integer<int32>

Specifies the maximum number of StatementJobs to retrieve per page.

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

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

​
active
string

Boolean filter on whether to only retrieve active (i.e. not completed/cancelled) StatementJobs.

  • TRUE - only active StatementJobs retrieved.
  • FALSE - all StatementJobs retrieved.
​
status
string

Filter using the StatementJobs status. Possible values:

  • PENDING
  • RUNNING
  • COMPLETE
  • CANCELLED
  • FAILED
​
billId
string

Filter Statement Jobs by billId

Response

Returns list of StatementJobs

​
data
object[]
​
nextToken
string