List External Mappings for a m3ter Entity
Changed onRetrieve a list of External Mapping entities for a specified m3ter entity.
Use this endpoint to retrieve a list of External Mapping entities associated with a specific m3ter entity. The list can be paginated for easier management.
Request
- Base URLhttps://api.m3ter.com
- AuthOAuth 2Authorization codehttps://m3ter.auth.us-east-1.amazoncognito.com/oauth2/authorize, token URL https://m3ter.auth.us-east-1.amazoncognito.com/oauth2/tokenClient credentialsToken URL /oauth/token
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
The unique identifier (UUID) of your Organization. The Organization represents your company as a direct customer of our service.
The entity type.
The unique identifer (UUID) of the m3ter entity.
Query parameters
Specifies the maximum number of External Mappings to retrieve per page.
The nextToken for multi-page retrievals. It is used to fetch the next page of External Mappings in a paginated list.
Response
Returns the list of External Mappings for a m3ter entity
Example response
{
"data": [
{
"m3terEntity": "Account",
"m3terId": "00000000-0000-0000-0000-000000000000",
"externalSystem": "Stripe",
"externalTable": "Customer",
"externalId": "cus_00000000000000",
"integrationConfigId": "00000000-0000-0000-0000-000000000000"
}
]
}Changes
- breaking
the
//////response's property type changed from no type toobjectfor status - breaking
the
//response's property type changed from no type toobjectfor status
- breaking
- breaking
the response's body type changed from no type to
objectfor status - info
added the optional property
to the response with the status - info
added the optional property
to the response with the status
- breaking