---
title: "List External Mappings"
method: GET
path: "/organizations/{orgId}/externalmappings"
tags: ["External Mapping"]
---

# List External Mappings

`GET /organizations/{orgId}/externalmappings`

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.

## Path parameters

- `orgId` string, required

## Query parameters

- `pageSize` integer
- `nextToken` string
- `externalSystemId` string
- `m3terIds` string[]
- `integrationConfigId` string

## Response `200`

Returns the list of External Mapping entities

- PaginatedExternalMappingResponseData
  - `data` ExternalMappingResponse[]
    - `id` string, required — The UUID of the entity.
    - `version` integer — The version number: - **Create:** On initial Create to insert a new entity, the version is set at 1 in the response. - **Update:** On successful Update, the version is incremented by 1 in the response.
    - `dtCreated` string, date-time — The DateTime when this item was created *(in ISO-8601 format)*.
    - `dtLastModified` string, date-time — The DateTime when this item was last modified *(in ISO-8601 format)*.
    - `createdBy` string — The ID of the user who created this item.
    - `lastModifiedBy` string — The ID of the user who last modified this item.
    - `m3terEntity` string, required — The name of the m3ter entity that is part of the External Mapping. For example, this could be "Account".
    - `m3terId` string, required — The unique identifier (UUID) of the m3ter entity.
    - `externalSystem` string, required — The name of the external system where the entity you are mapping resides.
    - `externalTable` string, required — The name of the table in the external system where the entity resides.
    - `externalId` string, required — The unique identifier (UUID) of the entity in the external system.
    - `integrationConfigId` string — UUID of the configuration this mapping is for
  - `nextToken` string

## Other responses

- `4XX` — Error message
- `5XX` — Error message

## Changes

- **2025-08-01** `9f9e5f3dbde7` — 1 breaking, 2 info
  - the response's body type/format changed from ``/`` to `object`/`` for status `200`
  - added the optional property `data` to the response with the `200` status
  - added the optional property `nextToken` to the response with the `200` status
- **2025-02-04** `9433593378b5` — 1 breaking, 2 warning, 1 info
  - the response's body type/format changed from `object`/`` to ``/`` for status `200`
  - removed the optional property `data` from the response with the `200` status
  - removed the optional property `nextToken` from the response with the `200` status
  - added the new optional `query` request parameter `integrationConfigId`

[Change history](https://skmtc.dev/m3ter-com/apis/m3ter-api/changes/organizations/:orgId/externalmappings/get.md)

---

[API](https://skmtc.dev/m3ter-com/apis/m3ter-api.md) · [All operations](https://skmtc.dev/m3ter-com/apis/m3ter-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/m3ter-com/m3ter-api/revisions/ac93d1a9e6d9/schema)