How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

M3ter External Mapping API

Endpoints for managing External Mapping related operations such as creation, update, list and delete.When you integrate your 3rd-party systems with the m3ter platform, a mapping between entities in the local system *(m3ter)* and external systems is constructed. This *External Mapping* is crucial in scenarios where data from external systems is consumed or where data from the local system is to be synchronized with external systems. When you are working to set up your Integrations and want to test or troubleshoot your implementation before going live, you might need to create External Mappings manually and, at a later date, edit or delete them.

M3ter External Mapping API is one of 58 APIs that M3ter publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include External Mapping. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, authentication docs, and a getting-started guide.

This API exposes 10 operations across 7 paths, and defines 9 schemas. It is described by OpenAPI 3.0.1, at version 1.0.

Requests are made against a single base URL, https://api.m3ter.com.

10 operations 7 paths 9 schemas 1 DELETE7 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.0
Base URL
https://api.m3ter.com
Authentication
OAuth 2.0
Resource Areas
1

Authentication & Security 1

M3ter External Mapping API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (OAuth2) using the clientCredentials and authorizationCode flows, exposing 6 scopes. By default, every request must be authenticated.

  • OAuth2 — m3ter supports machine to machine authentication using the clientCredentials OAuth2 flow. The authorizationCode flow controls access for human users via the m3…

Paths & Operations 10

Across 7 paths, the API surfaces 10 operations — 1 DELETE, 7 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

External Mapping 10

Endpoints for managing External Mapping related operations such as creation, update, list and delete. When you integrate your 3rd-party systems with the m3ter platform, a mapping…

GET
/organizations/{orgId}/externalmappings
List External Mappings
ListExternalMappings 6 params → 2004XX5XX
POST
/organizations/{orgId}/externalmappings
Create an External Mapping
CreateExternalMapping 1 param body → 2004XX5XX
GET
/organizations/{orgId}/externalmappingconfiguration/values/{destination}/{entityType}/{integrationCredentialsId}
Retrieve a list of external entities from the destination system for a particular credential
GetExternalMappingOptionsForDestinationForCredentialsId 5 params → 2004XX5XX
GET
/organizations/{orgId}/externalmappingconfiguration/values/{destination}/{entityType}
Retrieve External Entities from Destination
GetExternalMappingOptionsForDestination 4 params → 2004XX5XX
GET
/organizations/{orgId}/externalmappingconfiguration
Retrieve External Mapping Configuration
GetExternalMappingConfiguration 1 param → 2004XX5XX
GET
/organizations/{orgId}/externalmappings/externalid/{system}/{externalTable}/{externalId}
List External Mappings for External Entity
ListExternalMappingsForExternalSystemAndEntity 6 params → 2004XX5XX
GET
/organizations/{orgId}/externalmappings/external/{entity}/{m3terId}
List External Mappings for a m3ter Entity
ListExternalMappingsForM3terEntity 5 params → 2004XX5XX
GET
/organizations/{orgId}/externalmappings/{id}
Retrieve External Mapping
GetExternalMapping 2 params → 2004XX5XX
PUT
/organizations/{orgId}/externalmappings/{id}
Update External Mapping
UpdateExternalMapping 2 params body → 2004XX5XX
DELETE
/organizations/{orgId}/externalmappings/{id}
Delete an External Mapping
DeleteExternalMapping 2 params → 2004XX5XX

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are ExternalMappingRequest (6 properties), ExternalSystemResponse (3 properties), ExternalEntityResponse (2 properties), PaginatedExternalMappingResponseData (2 properties). Each schema is shown below with its type and property counts.

ExternalEntityResponse
object
Response containing an entity on an external system
2 properties
ExternalMappingRequest
object
Request containing an External Mapping entity.
6 properties 5 required
ExternalMappingResponse
object
Response containing an External Mapping entity.
PaginatedExternalMappingResponseData
object
2 properties
AbstractResponse
object
2 properties 1 required
ExternalSystemResponse
object
Response containing external system and permitted tables.
3 properties 1 required
ExternalMappingConfigurationResponse
object
Response containing permitted External Mapping configuration.
2 properties 2 required
AbstractResponseWithAuditFields
object
AbstractRequest
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

m3ter-external-mapping-api-openapi.yml Raw ↑

Other APIs M3ter publishes across the network.

M3ter Account API
M3ter AccountPlan API
M3ter Aggregation API
M3ter Auth API
M3ter BalanceChargeSchedule API
M3ter Balances API
M3ter BalanceTransactionSchedule API
M3ter Bill API
M3ter BillConfig API
M3ter BillGroupingKey API
M3ter BillJob API
M3ter Charge API
Where this information came from

This is an independent, third-party profile of M3ter External Mapping API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.