Sign in
External Mapping

List External Mappings

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

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

m3terIdsstring[]

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

Changed in 2 of the 10 revisions of this API.223

  • 9f9e5f3dbde712See the full diff
    • ▲

      the response's body type/format changed from / to object/ for status 200

      response-body-type-changed

    • ○

      added the optional property data to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property nextToken to the response with the 200 status

      response-optional-property-added

    This revision also has 53 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 9433593378b5121See the full diff
    • ▲

      the response's body type/format changed from object/ to / for status 200

      response-body-type-changed

    • ●

      removed the optional property data from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property nextToken from the response with the 200 status

      response-optional-property-removed

    • ○

      added the new optional query request parameter integrationConfigId

      new-optional-request-parameter

    This revision also has 41 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog