Skip to main content
GET
/
organizations
/
{orgId}
/
integrationconfigs
/
entity
/
{entityType}
Retrieve IntegrationConfig
curl --request GET \
  --url https://api.m3ter.com/organizations/{orgId}/integrationconfigs/entity/{entityType} \
  --header 'Authorization: Bearer <token>'
{
  "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>"
}

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

​
entityType
string
required

The entity to retrieve the configuration for.

Query Parameters

​
entityId
string

UUID of the entity to retrieve IntegrationConfigs for

​
destination
string

Destination type to retrieve IntegrationConfigs for

​
destinationId
string

UUID of the destination to retrieve IntegrationConfigs for

​
nextToken
string

nextToken for multi page retrievals

​
pageSize
integer<int32>

Number of configs to retrieve per page

Required range: 1 <= x <= 200

Response

Return the IntegrationConfig

Response containing an IntegrationRun entity.

​
id
string
required

The UUID of the entity.

​
entityType
string
required

The type of entity the integration run is for. Two options:

  • Bill
  • Notification
Minimum string length: 1
​
entityId
string
required

The unique identifier (UUID) of the entity the integration run is for.

Minimum string length: 1
​
status
enum<string>
required

The current 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
​
destination
string
required

The destination system for the integration run.

​
version
integer<int64>

The version number:

  • Create: On initial Create to insert a new entity, the version is set at 1 in the response.
  • Update: On successful Update, the version is incremented by 1 in the response.
​
dtCreated
string<date-time>

The DateTime when this item was created (in ISO-8601 format).

​
dtLastModified
string<date-time>

The DateTime when this item was last modified (in ISO-8601 format).

​
createdBy
string

The ID of the user who created this item.

​
lastModifiedBy
string

The ID of the user who last modified this item.

​
dtStarted
string<date-time>

The date and time the integration run was started (in ISO-8601 format).

​
dtCompleted
string<date-time>

The date and time the integration was completed. (in ISO-8601 format).

​
destinationId
string

Identifier of the destination

​
error
string

Describes any errors encountered during the integration run.

​
url
string

The URL of the entity in the destination system if available.

​
externalId
string

The external ID in the destination system if available.

​
parentIntegrationRunId
string

ID of the parent integration run, or null if this is a parent integration run