Sign in

v10

latestOpenAPI 3.0.1raw.githubusercontent.com2025-12-033223581.2 MB
External Mapping

List External Mappings for External Entity

Retrieve a list of External Mapping entities for a specified external system entity.

Use this endpoint to retrieve a list of External Mapping entities associated with a specific external system entity. The list can be paginated for easier management.

get/organizations/{orgId}/externalmappings/externalid/{system}/{externalTable}/{externalId}

Path parameters

orgIdstring required

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

systemstring required

The identifier for the external system.

externalTablestring required

The identifier for the external table.

externalIdstring required

The unique identifier (UUID) for the external 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 Mapping entities for the external entity

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"
    }
  ]
}