Skip to main content
GET
/
organizations
/
{orgId}
/
integrationruns
/
{entityType}
/
{entityId}
List IntegrationRuns
curl --request GET \
  --url https://api.m3ter.com/organizations/{orgId}/integrationruns/{entityType}/{entityId} \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "entityType": "<string>",
      "entityId": "<string>",
      "status": "WAITING",
      "destination": "<string>",
      "version": 123,
      "dtCreated": "2023-11-07T05:31:56Z",
      "dtLastModified": "2023-11-07T05:31:56Z",
      "createdBy": "<string>",
      "lastModifiedBy": "<string>",
      "dtStarted": "2023-11-07T05:31:56Z",
      "dtCompleted": "2023-11-07T05:31:56Z",
      "destinationId": "<string>",
      "error": "<string>",
      "url": "<string>",
      "externalId": "<string>",
      "parentIntegrationRunId": "<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) for your Organization. The Organization represents your company as a direct customer of our service.

​
entityId
string
required

The UUID of the entity to retrieve the integration runs for.

​
entityType
string
required

The type of the entity you want to retrieve the integration runs for. Two options:

  • Bill
  • Notification

Query Parameters

​
startDate
string

Retrieve only those integration runs started after the specified date/time.(ISO 8601 formatted)

​
endDate
string

Retrieve only those integration runs started before or on the specified date/time.(ISO 8601 formatted)

​
pageSize
integer<int32>

Number of integration runs to retrieve per page.

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

nextToken for multi page retrievals.

​
status
enum<string>

Status of the integration run

Available options:
WAITING,
STARTED,
COMPLETE,
ERROR,
AWAITING_RETRY,
AUTH_FAILED,
ACCOUNTING_PERIOD_CLOSED,
INVOICE_ALREADY_PAID,
DISABLED,
TIMEOUT_LIMIT_EXCEEDED,
RATE_LIMIT_RETRY
​
order
enum<string>

Integration runs order

Available options:
ASC,
DESC

Response

Return the Integration Runs

​
data
object[]
​
nextToken
string