Skip to main content
GET
/
organizations
/
{orgId}
/
externalmappings
List External Mappings
curl --request GET \
  --url https://api.m3ter.com/organizations/{orgId}/externalmappings \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "m3terEntity": "Account",
      "m3terId": "00000000-0000-0000-0000-000000000000",
      "externalSystem": "Stripe",
      "externalTable": "Customer",
      "externalId": "cus_00000000000000",
      "version": 123,
      "dtCreated": "2023-11-07T05:31:56Z",
      "dtLastModified": "2023-11-07T05:31:56Z",
      "createdBy": "<string>",
      "lastModifiedBy": "<string>",
      "integrationConfigId": "00000000-0000-0000-0000-000000000000"
    }
  ],
  "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 External Mappings to retrieve per page.

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

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

​
externalSystemId
string

The name of the external system to use as a filter.

For example, if you want to list only those external mappings created for your Organization for the Salesforce external system, use:

?externalSystemId=Salesforce

​
m3terIds
object[]

IDs for m3ter entities

​
integrationConfigId
string

ID of the integration config

Response

Returns the list of External Mapping entities

​
data
object[]
​
nextToken
string