External Mapping
List External Mappings for a m3ter Entity
Retrieve 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.
get/organizations/{orgId}/externalmappings/external/{entity}/{m3terId}
Path parameters
orgIdstring required
The unique identifier (UUID) of your Organization. The Organization represents your company as a direct customer of our service.
entitystring required
The entity type.
m3terIdstring required
The unique identifer (UUID) of the m3ter entity.
Query parameters
pageSizeinteger
Specifies the maximum number of External Mappings to retrieve per page.
nextTokenstring
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"
}
]
}