M3m3ter-com
External Mapping

List External Mappings

Changed on

Retrieve a list of all External Mapping entities.

This endpoint retrieves a list of all External Mapping entities for a specific Organization. The list can be paginated for better management, and supports filtering using the external system.

get/organizations/{orgId}/externalmappings

Request

Path parameters

orgIdstring required

The unique identifier (UUID) of your Organization. The Organization represents your company as a direct customer of our service.

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.

externalSystemIdstring

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

m3terIdsobject[]

IDs for m3ter entities

integrationConfigIdstring

ID of the integration config

Response

Returns the list of External Mapping entities

nextTokenstring

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

  • 85c514abc692Revision changes
    • breaking

      for the query request parameter m3terIds, the type of property items/ was specialized from string to object

    • breaking

      the ////// response's property type changed from no type to object for status

    • breaking

      the // response's property type changed from no type to object for status

  • 9f9e5f3dbde7Revision changes
    • breaking

      the response's body type changed from no type to object for status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status